v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB

Agent

List agents

Get agents of the user.

get/agents

Query parameters

page_sizeinteger

Example:25

Number of results to return per page.

page_tokenstring

Cursor token for pagination. Use the next_page_token value from the previous response.

tag_idsstring

Comma separated tag ids.

Current availability status of the agent.

Example:available

Agent status.

Response

Successful response.

next_page_tokenstring

Cursor token for the next page of results. Pass this value as the page_token parameter in the next request.

Example response

{
  "result": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "username": "agent@example.com",
      "name": "John Smith",
      "detail": "Senior support agent",
      "ring_method": "ringall",
      "status": "available",
      "permission": 64,
      "tag_ids": [
        "b1a2c3d4-e5f6-7890-abcd-ef1234567890"
      ],
      "addresses": [
        {
          "type": "tel",
          "target": "+14155551234",
          "target_name": "John Smith",
          "name": "Main Office",
          "detail": "Primary contact number"
        }
      ],
      "direct_hash": "a8f3b2c1d4e5",
      "tm_create": "2026-01-15T09:30:00.000000Z",
      "tm_update": "2026-01-16T14:20:00.000000Z",
      "tm_delete": "2026-01-17T10:00:00.000000Z"
    }
  ]
}