Routing

Get users assigned to a queue

Changed on

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

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

Request

Path parameters

queue_idinteger required
Example:1

The unique identifier of the queue.

Query parameters

limitinteger

The number of items to return.

offsetinteger

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

Response

OK

Example response

{
  "users": [
    {
      "id": 1,
      "name": "Jane Doe",
      "email": "jane.doe@companyname.com",
      "sip_account": "jane.doe@contactcenter.com",
      "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",
            "created_at": "2026-01-15T10:30:00.123000Z",
            "updated_at": "2026-01-20T14:15:00.456000Z"
          },
          "value": 5
        }
      ],
      "status": "available",
      "created_at": "2025-11-11T12:00:00.216000Z",
      "updated_at": "2025-11-11T12:00:00.216000Z",
      "deleted_at": "2025-11-11T12:00:00.216000Z"
    }
  ],
  "metadata": {
    "total": 100
  }
}

Changes

    • breaking

      for the query request parameter limit, the max was decreased from 1000.00 to 100.00

    • breaking

      the response property // became nullable for the status

    • warning

      added the new cs enum value to the // response property for the response status

    • warning

      added the new hu enum value to the // response property for the response status

    • warning

      added the new ja enum value to the // response property for the response status

    • warning

      added the new lt enum value to the // response property for the response status

    • warning

      added the new lv enum value to the // response property for the response status

    • warning

      added the new ro enum value to the // response property for the response status

    • warning

      added the new sk enum value to the // response property for the response status

    • warning

      added the new tr enum value to the // response property for the response status

    • info

      added the optional property // to the response with the status