latestOpenAPI 3.0.02026-08-10416661.5 MB

e96b3e58b041

Teams

Get team members

REQUIRED SCOPES <code>['teams:read']</code><br>Returnes a list of all the members within a particular team. This API endpoint also allows for filtering team members before fetching by user's first name or last name.

get/teams/{team}/members

Path parameters

teaminteger required

Team

Query parameters

querystring

Filter by user's first_name or last_name

limitinteger

Limit

offsetinteger

Offset

Response

OK

idinteger
emailstring
first_namestring
last_namestring
full_namestring
rolestring
inbox_idinteger
organization_idinteger
photo_urlstring
unreadinteger
numberstring
formatted_numberstring
isRingEverywhereboolean
userPermissionsstring[]
team_rolestring
user_rolestring
has_inbox_access_requestboolean
has_change_role_requestboolean
member_teams_countinteger
calling_enabledboolean
cannot_removeinteger[]

Array of inbox IDs where user cannot be removed due to settings conflicts

Example response

[
  {
    "team_role": "member",
    "user_role": "admin",
    "member_teams_count": 3,
    "calling_enabled": true,
    "cannot_remove": [
      100015945
    ]
  }
]