The company directory: people, roles, availability, readiness

GET

/v1/workspace/team

const url = 'https://api.vocapable.com/v1/workspace/team';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

The whole directory: the web People tab scopes teammate detail, not the list.

Authorizations

HTTPBearer

Responses

200

Successful Response

application/json

WorkspaceTeam

object

data

required

Data

Array<object>

WorkspaceTeamMember

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

object

user_id

required

Any of:

string
null

string

membership_id

required

Any of:

string
null

string

invitation_id

required

Any of:

string
null

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
null

string

presence_until

required

Any of:

string
null

string format: date-time

presence_revision

required

Any of:

integer
null

integer

device

required

Any of:

WorkspaceDeviceReadiness
null

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
null

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

Example

{
  "data": [
    {
      "role": "owner",
      "status": "active",
      "presence": "available",
      "device": {
        "kind": "browser",
        "result": "ready"
      },
      "teams": [
        {
          "is_primary": false
        }
      ]
    }
  ]
}