Skip to main content
POST
List groups
Required scopes: groups--all:ro

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
fields
enum<string>[]

The additional fields to include in the response.

  • agent_priorities — an object containing agents belonging to a group, along with their priorities.
  • routing_status — the routing status of a group.
Available options:
agent_priorities,
routing_status

Response

200 - application/json

A list of groups.

id
integer

The group ID.

name
string

The name of the group.

language_code
string

The code of the group language.

agent_priorities
object

Agent priorities in the group as a map in the "<id>": "<priority>" format. Returned only when agent_priorities is passed in the fields parameter.

routing_status
string

The routing status of the group. Returned only when routing_status is passed in the fields parameter.