v1

latestOpenAPI 3.0.32026-07-246376162.1 KB
Routing

Get queues

Returns a paginated list of all routing queues.

get/api/v4/routing/queues

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

{
  "queues": [
    {
      "id": 1,
      "name": "Technical Support",
      "extension": "4000",
      "strategy": "ring_all",
      "music_on_hold": {
        "type": "music_on_hold",
        "name": "Morning coffee (Default)"
      },
      "in_queue_announcement": {
        "interval": 60,
        "voice_message": {
          "type": "voice_message",
          "name": "Instructions"
        },
        "announce_position": true,
        "announce_wait_time": true
      },
      "failover_destination": {
        "wait_time": 300,
        "destination": {
          "type": "agent",
          "agent": {
            "id": 1,
            "name": "Jane Doe",
            "email": "jane.doe@contactcenter.com"
          }
        }
      },
      "callback": {
        "wait_time": 300,
        "caller_id_group": {
          "id": 1,
          "name": "Default"
        },
        "offer_voice_message": {
          "type": "voice_message",
          "name": "Instructions"
        },
        "confirmation_voice_message": {
          "type": "voice_message",
          "name": "Instructions"
        }
      },
      "post_call_rating": {
        "notification_voice_message": {
          "type": "voice_message",
          "name": "Instructions"
        },
        "instruction_voice_message": {
          "type": "voice_message",
          "name": "Instructions"
        },
        "complete_voice_message": {
          "type": "voice_message",
          "name": "Instructions"
        }
      },
      "channels": [
        {
          "channel": "whatsapp",
          "priority": 1
        }
      ],
      "skills": [
        {
          "id": 1,
          "name": "Sales",
          "created_at": "2026-01-15T10:30:00.123000Z",
          "updated_at": "2026-01-20T14:15:00.456000Z"
        }
      ],
      "created_at": "2026-01-15T10:30:00.123000Z",
      "updated_at": "2026-01-20T14:15:00.456000Z"
    }
  ],
  "metadata": {
    "total": 100
  }
}