Get users assigned to a queue

Returns the list of users who are assigned to the specified queue.

The Get users assigned to a queue endpoint returns the users assigned to a specific inbound routing queue.

Requirements: Base URL, Authentication, Error codes

Scope: routing.queues.read

What this does

When you send a Get users assigned to a queue request with a queue ID, Voiso returns a paginated list of users assigned to that queue.

When to use it

  • Display or sync queue membership in an external system
  • Build an admin UI that shows which users belong to a queue
  • Validate routing configuration during audits or troubleshooting

Prerequisites

  • The queue must exist in the contact center.
  • You must have access to the queue.

Endpoint


GET /api/v4/routing/queues/{queue_id}/users

Request parameters

Path parameters

  • queue_id
    The unique identifier of the queue.

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/routing/queues/1/users" \
  -H "Authorization: Bearer <contact_center_api_key>" \
  -H "Content-Type: application/json"

Request the second page of results (50 per page)

curl -X GET "https://{cluster_id}.voiso.com/api/v4/routing/queues/1/users?limit=50&offset=50" \
  -H "Authorization: Bearer <contact_center_api_key>" \
  -H "Content-Type: application/json"

Response

If successful, the API returns an array of user objects and pagination metadata.

{
  "users": [
    {
      "id": "0b97ce11-b6e0-49b4-8f92-68040aa324bf",
      "name": "Jane Doe",
      "email": "[email protected]",
      "sip_account": "[email protected]",
      "extension": "102",
      "caller_id": "12025550123",
      "employee_id": "E-482",
      "timezone": "America/New_York",
      "security_access_group": {
        "id": 3,
        "name": "Boarding"
      },
      "teams": [
        {
          "id": 3,
          "name": "Multilingual Support"
        }
      ],
      "supervised_teams": [
        {
          "id": 3,
          "name": "Multilingual Support"
        }
      ],
      "queues": [
        {
          "id": 1,
          "name": "Technical Support"
        }
      ],
      "supervised_queues": [
        {
          "id": 1,
          "name": "Technical Support"
        }
      ],
      "webrtc_ringtone": {
        "type": "ringtone",
        "name": "Bells (Default)"
      },
      "channels": [
        "voice",
        "chat",
        "whatsapp"
      ],
      "channel_group_capacity": {
        "chat": 5,
        "instant": 3
      },
      "channel_profiles": [
        {
          "id": 12,
          "channel": "whatsapp",
          "identifier": "18885658889",
          "name": "WhatsApp Main (18885658889)"
        }
      ],
      "speech_language": "en",
      "skills": [
        {
          "skill": {
            "id": 1,
            "name": "Sales"
          },
          "value": 5
        }
      ],
      "status": "available",
      "created_at": "2025-11-11T12:00:00.216Z",
      "updated_at": "2025-11-11T12:00:00.216Z",
      "deleted_at": "2025-11-11T12:00:00.216Z"
    }
  ],
  "metadata": {
    "total": 100
  }
}

Next steps

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 this queue.

404 Not found

This usually means the queue ID does not exist, or you do not have access to it.

What to check:

429 Too many requests

What to do:

  • Reduce request frequency and retry with backoff.
Path Params
integer
required

The unique identifier of the queue.

Query Params
integer
0 to 1000
Defaults to 100

The number of items to return.

integer
≥ 0
Defaults to 0

The number of items to skip before starting to collect the result set.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json