Skip to content
vocapable.Docs

One teammate: availability, readiness, and work

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
user_id
required
User Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceTeammateDetail
object
row
required
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
can_see_work
required
Can See Work
boolean
today
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
latest_activity
required
Latest Activity
Array<object>
WorkspaceTimelineEntry
object
id
required
Id
string
organization_id
required
Any of:
string
contact_id
required
Any of:
string
opportunity_id
required
Any of:
string
kind
required
Kind
string
Allowed values: call note message ai stage task meeting quote handoff case import ownership policy integration
title
required
Title
string
body
required
Any of:
string
actor
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
actor_kind
required
Actor Kind
string
Allowed values: human ai system integration
subject_type
required
Any of:
string
subject_id
required
Any of:
string
occurred_at
required
Occurred At
string format: date-time
owned_work
required
Owned Work
Array<object>
WorkspaceOwnedWork
object
organization_id
required
Organization Id
string
name
required
Name
string
next_step
required
Any of:
string
link
required
Link
string
readiness_detail
required
Readiness Detail
string
can_manage
required
Can Manage
boolean
active_call
required
Active Call
boolean
Example
{
  "row": {
    "member": {
      "role": "owner",
      "status": "active",
      "presence": "available",
      "device": {
        "kind": "browser",
        "result": "ready"
      },
      "teams": [
        {
          "is_primary": false
        }
      ]
    },
    "teams": [
      {
        "is_primary": false
      }
    ],
    "custom_role": {
      "scope": "company"
    }
  },
  "latest_activity": [
    {
      "kind": "call",
      "actor_kind": "human"
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}