get
https://{defaultHost}/api/v4/users/teams
Returns a paginated list of all teams.
The Get list of teams endpoint returns the teams you can access.
Requirements: Base URL, Authentication, Error codes
Scope: users.teams.read
What this does
When you send a Get list of teams request,
Voiso
returns a paginated list of team objects.
When to use it
- Populate a team selector in an external tool
- Retrieve team IDs to use in other requests, such as filtering users
Prerequisites
- At least one team is configured in your contact center.
Endpoint
GET /api/v4/teams
Query parameters
All query parameters are optional.
- limit
The number of items to return. Default is 100. Maximum is 100. - offset
The number of items to skip before collecting results. Default is 0.
Examples
Minimal request
curl -X GET "https://{cluster_id}.voiso.com/api/v4/teams" \
-H "Authorization: Bearer <contact_center_api_key>" \
-H "Content-Type: application/json"Request the third page of results (20 per page)
curl -X GET "https://{cluster_id}.voiso.com/api/v4/teams?limit=20&offset=40" \
-H "Authorization: Bearer <contact_center_api_key>" \
-H "Content-Type: application/json"Response
If successful, the API returns an array of team objects and pagination metadata.
{
"teams": [
{
"id": 3,
"name": "Multilingual Support"
}
],
"metadata": {
"total": 100
}
}Troubleshooting
401 Unauthorized
What to check:
- You are sending
Authorization: Bearer <contact_center_api_key>. - Your Base URL includes the correct
{cluster_id}.
403 Forbidden
What to check:
- The API key is valid, but does not have access to teams in this contact center.
429 Too many requests
What to do:
- Reduce request frequency and retry with backoff.