---
title: "Get a list of groupcalls"
method: GET
path: "/groupcalls"
tags: ["Groupcall"]
---

# Get a list of groupcalls

`GET /groupcalls`

Retrieves a list of groupcalls based on the provided parameters.

## Query parameters

- `page_size` integer
- `page_token` string

## Response `200`

A list of groupcalls.

- object
  - `next_page_token` string — Cursor token for the next page of results. Pass this value as the page_token parameter in the next request.
  - `result` CallManagerGroupcall[]
    - `id` string, uuid — The unique identifier of the group call.
    - `customer_id` string, uuid — The customer ID that owns this group call. Returned from the `GET /customers` response.
    - `owner_type` string — Type of the resource owner (e.g., agent, queue).
    - `owner_id` string, uuid — The unique identifier of the resource owner. Returned from the corresponding owner resource endpoint (e.g., `GET /agents`, `GET /queues`).
    - `status` 'progressing' | 'hangingup' | 'hangup' — Current status of the call or group call
    - `flow_id` string, uuid — The flow ID associated with this group call. Returned from the `POST /flows` or `GET /flows` response.
    - `source` CommonAddress — Contains source or destination detail info.
      - `type` '' | 'agent' | 'conference' | 'email' | 'extension' | 'line' | 'sip' | 'tel' | 'web_session' — Type of address.
      - `target` string — The address endpoint. Format depends on type: phone number for tel (e.g. +14155551234), UUID for agent/conference/extension, email for email, SIP URI for sip.
      - `target_name` string — Address's name.
      - `name` string — Optional label for this address.
      - `detail` string — Additional notes about this address.
    - `destinations` CommonAddress[] — List of target addresses. Must contain at least one destination.
      - `type` '' | 'agent' | 'conference' | 'email' | 'extension' | 'line' | 'sip' | 'tel' | 'web_session' — Type of address.
      - `target` string — The address endpoint. Format depends on type: phone number for tel (e.g. +14155551234), UUID for agent/conference/extension, email for email, SIP URI for sip.
      - `target_name` string — Address's name.
      - `name` string — Optional label for this address.
      - `detail` string — Additional notes about this address.
    - `master_call_id` string, uuid, nullable — The unique identifier of the master call that initiated this group call. Returned from the `POST /calls` or `GET /calls` response.
    - `master_groupcall_id` string, uuid, nullable — The unique identifier of the master group call, if applicable. Returned from the `POST /groupcalls` or `GET /groupcalls` response.
    - `ring_method` '' | 'ring_all' | 'linear' — Method used for dialing
    - `answer_method` '' | 'hangup_others' — Method to handle answered calls
    - `answer_call_id` string, uuid — The unique identifier of the answered call. Returned from the `POST /calls` or `GET /calls` response.
    - `call_ids` string[] — List of associated call IDs. Each ID is returned from the `POST /calls` or `GET /calls` response.
    - `answer_groupcall_id` string, uuid — The unique identifier of the answered group call. Returned from the `POST /groupcalls` or `GET /groupcalls` response.
    - `groupcall_ids` string[] — List of associated group call IDs. Each ID is returned from the `POST /groupcalls` or `GET /groupcalls` response.
    - `call_count` integer — Number of remaining calls in the current dial.
    - `groupcall_count` integer — Number of remaining group calls in the current dial.
    - `dial_index` integer, nullable — Current dial index, valid only when the ring method is "ring_all".
    - `tm_create` string, date-time — The creation timestamp.
    - `tm_update` string, date-time — The last update timestamp.
    - `tm_delete` string, date-time, nullable — The deletion timestamp, if applicable.

## Other responses

- `401` — Authentication required (UNAUTHENTICATED).
- `500` — Internal error (INTERNAL).

---

[API](https://skmtc.net/voipbin/apis/voipbin-api.md) · [All operations](https://skmtc.net/voipbin/apis/voipbin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/voipbin/voipbin-api/versions/79e779080bcc/schema)