Teams
Teams are groups of Spoke Users and SIP Devices.
List teams
Lists the teams in your organisation.
This endpoint supports paging. By default the API will return 100 teams, configurable up to a maximum of 1000 teams at a time. If the result from a previous call includes a next value in the result set you can use the value returned as the next parameter in the query string to retrieve the next page of results.
query Parameters
Headers
AuthorizationAuthorization header bearing the access token
List teams › Responses
Teams
The list of teams returned by the query.
Add a user to a team
Add a user to the specified team, or update the user's offer priority if they are already a member.
path Parameters
Headers
AuthorizationAuthorization header bearing the access token
Add a user to a team › Request Body optional
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| No specific criteria |
ringFirstControls whether the user is in the team's 'call first' group when people call this team, according to the team's calling rules. Defaults to true.
Add a user to a team › Responses
The user has been added to the team
Remove a user from a team
Remove a user from the specified team.
path Parameters
Headers
AuthorizationAuthorization header bearing the access token
Remove a user from a team › Responses
Successfully removed the user from the team