v51

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

Groupcall

Get a list of groupcalls

Retrieves a list of groupcalls based on the provided parameters.

get/groupcalls

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.

Response

A list of groupcalls.

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",
      "owner_type": "agent",
      "owner_id": "c2d3e4f5-a6b7-8901-2cde-f01234567890",
      "status": "progressing",
      "flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "source": {
        "type": "tel",
        "target": "+14155551234",
        "target_name": "John Smith",
        "name": "Main Office",
        "detail": "Primary contact number"
      },
      "destinations": [
        {
          "type": "tel",
          "target": "+14155551234",
          "target_name": "John Smith",
          "name": "Main Office",
          "detail": "Primary contact number"
        }
      ],
      "master_call_id": "4d5e6f7a-8b9c-0123-def0-123456789012",
      "master_groupcall_id": "5e6f7a8b-9c0d-1234-ef01-234567890123",
      "ring_method": "ring_all",
      "answer_method": "hangup_others",
      "answer_call_id": "550e8400-e29b-41d4-a716-446655440000",
      "call_ids": [
        "550e8400-e29b-41d4-a716-446655440000"
      ],
      "answer_groupcall_id": "5e6f7a8b-9c0d-1234-ef01-234567890123",
      "groupcall_ids": [
        "5e6f7a8b-9c0d-1234-ef01-234567890123"
      ],
      "call_count": 2,
      "groupcall_count": 1,
      "tm_create": "2026-01-15T09:30:00.000000Z",
      "tm_update": "2026-01-15T09:30:00.000000Z",
      "tm_delete": "2026-01-15T09:30:00.000000Z"
    }
  ]
}