Skip to content
vocapable.Docs

The People tab: who can answer, who is busy, who is invited

GET
/v1/workspace/team/people
curl --request GET \
  --url https://api.vocapable.com/v1/workspace/team/people \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspacePeople
object
stats
required
WorkspacePeopleStats
object
ready_to_answer
required
Ready To Answer
integer
helping_customers
required
Helping Customers
integer
handoffs_to_finish
required
Handoffs To Finish
integer
rows
required
Rows
Array<object>
WorkspacePeopleRow
object
member
required
WorkspaceTeamMember

One person in the company directory. Invited is not ready.

object
user_id
required
Any of:
string
membership_id
required
Any of:
string
invitation_id
required
Any of:
string
name
required
Name
string
email
required
Email
string
role
required
Role
string
Allowed values: owner manager rep
status
required
Status
string
Allowed values: active invited suspended
presence
required
Presence
string
Allowed values: available away offline unknown invited
presence_reason
required
Any of:
string
presence_until
required
Any of:
string format: date-time
presence_revision
required
Any of:
integer
device
required
Any of:
WorkspaceDeviceReadiness
object
kind
required
Kind
string
Allowed values: browser mobile
label
required
Label
string
result
required
Result
string
Allowed values: ready mic_blocked unsupported network
checked_at
required
Checked At
string format: date-time
ready
required
Ready
boolean
stale
required
Stale
boolean
push_ready
required
Push Ready
boolean
human_rep_id
required
Any of:
string
is_you
required
Is You
boolean
teams
Teams
Array<object>
WorkspaceTeamTag

A team a person belongs to, as shown beside their name.

object
team_id
required
Team Id
string
name
required
Name
string
is_lead
required
Is Lead
boolean
is_primary
Is Primary
boolean
presence_label
required
Presence Label
string
device_label
required
Device Label
string
ready_to_answer
required
Ready To Answer
boolean
on_call
required
On Call
boolean
invitation
required
Any of:
WorkspaceInvitationInfo
object
id
required
Id
string
full_name
required
Any of:
string
expires_at
required
Expires At
string format: date-time
created_at
required
Created At
string format: date-time
invited_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
metrics
required
Any of:
WorkspacePersonMetrics

One person’s work in the window, counted from real records.

object
calls
required
Calls
integer
conversations
required
Conversations
integer
won
required
Won
integer
follow_ups_completed
required
Follow Ups Completed
integer
teams
Teams
Array<object>
WorkspaceTeamTag

A team a person belongs to, as shown beside their name.

object
team_id
required
Team Id
string
name
required
Name
string
is_lead
required
Is Lead
boolean
is_primary
Is Primary
boolean
custom_role
Any of:
WorkspaceCustomRoleTag
object
role_id
required
Role Id
string
name
required
Name
string
scope
required
Scope
string
Allowed values: company teams
window
required
Window
string
definitions
required
Definitions
Array<object>
WorkspaceMetricDefinition
object
key
required
Key
string
label
required
Label
string
definition
required
Definition
string
progress
required
WorkspacePersonMetrics

One person’s work in the window, counted from real records.

object
calls
required
Calls
integer
conversations
required
Conversations
integer
won
required
Won
integer
follow_ups_completed
required
Follow Ups Completed
integer
progress_scope
required
Progress Scope
string
Allowed values: team self
live_fallback
required
Any of:
string
Allowed values: ai_receptionist callback
can_manage
required
Can Manage
boolean
Example
{
  "rows": [
    {
      "member": {
        "role": "owner",
        "status": "active",
        "presence": "available",
        "device": {
          "kind": "browser",
          "result": "ready"
        },
        "teams": [
          {
            "is_primary": false
          }
        ]
      },
      "teams": [
        {
          "is_primary": false
        }
      ],
      "custom_role": {
        "scope": "company"
      }
    }
  ],
  "progress_scope": "team",
  "live_fallback": "ai_receptionist"
}