> ## Documentation Index
> Fetch the complete documentation index at: https://www.cometchat.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List Calls

> lists all the calls that are available in the app. It can include participants, and recordings property in the response (if present).

Retrieve a paginated list of all calls in your application. Use query parameters to filter by call type, status, date range, and more.

## Common Use Cases

| Use Case                       | Query Parameters       |
| ------------------------------ | ---------------------- |
| Get all video calls            | `type=video`           |
| Get ongoing calls              | `status=ongoing`       |
| Get calls with recordings      | `hasRecording=true`    |
| Get calls for a specific user  | `uid=user123`          |
| Get group calls only           | `receiverType=group`   |
| Get calls from a specific date | `startedAt=1692368000` |

## Example Request

```bash theme={null}
curl -X GET "https://{appId}.call-{region}.cometchat.io/v3/calls?type=video&status=ended&hasRecording=true" \
  -H "apikey: YOUR_REST_API_KEY"
```

## Filtering Tips

* Combine multiple filters to narrow results (e.g., `type=video&status=ended`)
* Use `startedAt` and `endedAt` for date range queries (Unix timestamps)
* Filter by `participantsCount` to find calls with specific attendance
* Use `uid` to get all calls involving a specific user

<Note>
  Results are paginated. Check the `meta.pagination` object in the response for total count and page information.
</Note>


## OpenAPI

````yaml get /calls
openapi: 3.1.0
info:
  title: calls-api
  version: '3'
servers:
  - url: https://{appId}.call-{region}.cometchat.io/v3
    variables:
      appId:
        default: appId
      region:
        default: region
security:
  - sec0: []
paths:
  /calls:
    get:
      summary: List Calls
      description: >-
        lists all the calls that are available in the app. It can include
        participants, and recordings property in the response (if present).
      operationId: list-calls
      parameters:
        - name: type
          in: query
          description: 'It includes the type of the call, possible values: audio & video'
          schema:
            type: string
            enum:
              - audio
              - video
            description: 'Allowed values: audio, video'
        - name: mode
          in: query
          description: >-
            It represents the mode of call, possible values: call, meet &
            presenter.
          schema:
            type: string
            enum:
              - call
              - meet
              - presenter
            description: 'Allowed values: call, meet, presenter'
        - name: participantsCount
          in: query
          description: >-
            This query parameter allows you to filter the list of calls based on
            the number of participants involved in each call. For example,
            participantsCount=5 will return calls that had exactly 5
            participants.
          schema:
            type: string
        - name: startedAt
          in: query
          description: >-
            It represents when the call was started. It's 10 digit unix
            timestamp.
          schema:
            type: integer
            format: int32
        - name: status
          in: query
          description: >-
            It indicates the status of the call. Possible values are initiated,
            ongoing, ended, unanswered, rejected, canceled.
          schema:
            type: string
            enum:
              - initiated
              - ongoing
              - ended
              - unanswered
              - rejected
              - canceled
            description: >-
              Allowed values: initiated, ongoing, ended, unanswered, rejected,
              canceled
        - name: receiverType
          in: query
          description: >-
            It indicates if it was 1-1 call of group call. Possible values: user
            & group.
          schema:
            type: string
            enum:
              - user
              - group
            description: 'Allowed values: user, group'
        - name: endedAt
          in: query
          description: It represents when the call was ended.
          schema:
            type: integer
            format: int32
        - name: hasRecording
          in: query
          description: >-
            It's a boolean field indicating if the call has recording present or
            not.
          schema:
            type: boolean
        - name: uid
          in: query
          description: It fetches only those calls in which the passed uid is a part of.
          schema:
            type: string
        - name: onBehalfOf
          in: header
          description: UID of the user on whose behalf the action is performed.
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                      "data": [
                        {
                          "sessionId": "v1.us.31780434a95d45.1692368168aefba73a1e5938ad7a02f8e61ea1c9a287a08aeb",
                          "totalAudioMinutes": 0.31666666666666665,
                          "totalVideoMinutes": 0,
                          "totalDuration": "00:00:19",
                          "hasRecording": false,
                          "initiatedAt": 1692368168,
                          "initiator": "cometchat-uid-8",
                          "mode": "call",
                          "receiver": "sivamathewstestgroup",
                          "receiverType": "group",
                          "status": "ended",
                          "totalDurationInMinutes": 0.31666666666666665,
                          "totalParticipants": 2,
                          "type": "audio",
                          "mid": "3f7596ac-854b-484d-b36c-d623e193bd81",
                          "startedAt": 1692368180,
                          "endedAt": 1692368199,
                          "participants": [
                            {
                              "uid": "cometchat-uid-2",
                              "totalAudioMinutes": 0.31666666666666665,
                              "totalVideoMinutes": 0,
                              "isJoined": true,
                              "state": "ended",
                              "totalDuration": 0.31666666666666665,
                              "deviceId": "b7683aaf-090a-4204-8f84-7ddd652923aa@rtc.cometchat.com/ucTKf4eq",
                              "joinedAt": 1692368180,
                              "mid": "3f7596ac-854b-484d-b36c-d623e193bd81",
                              "leftAt": 1692368199
                            },
                            {
                              "uid": "cometchat-uid-8",
                              "totalAudioMinutes": 0.2833333333333333,
                              "totalVideoMinutes": 0,
                              "isJoined": true,
                              "state": "ended",
                              "totalDuration": 0.2833333333333333,
                              "deviceId": "f55d46e5-2b1c-4b02-9072-382209a8753f@rtc.cometchat.com/K-s6dB3N",
                              "joinedAt": 1692368180,
                              "mid": "3f7596ac-854b-484d-b36c-d623e193bd81",
                              "leftAt": 1692368197
                            },
                            {
                              "uid": "cometchat-uid-4",
                              "totalAudioMinutes": 0,
                              "totalVideoMinutes": 0,
                              "isJoined": false,
                              "state": "unanswered",
                              "totalDuration": 0
                            },
                            {
                              "uid": "cometchat-uid-7",
                              "totalAudioMinutes": 0,
                              "totalVideoMinutes": 0,
                              "isJoined": false,
                              "state": "unanswered",
                              "totalDuration": 0
                            },
                            {
                              "uid": "cometchat-uid-6",
                              "totalAudioMinutes": 0,
                              "totalVideoMinutes": 0,
                              "isJoined": false,
                              "state": "unanswered",
                              "totalDuration": 0
                            }
                          ]
                        },
                        {
                          "sessionId": "v1.us.31780434a95d45.16923681138d75114d60d1345a22e4cc612263fb26c0b5cf92",
                          "totalAudioMinutes": 0.31666666666666665,
                          "totalVideoMinutes": 0,
                          "totalDuration": "00:00:19",
                          "hasRecording": false,
                          "initiatedAt": 1692368113,
                          "initiator": "cometchat-uid-8",
                          "mode": "call",
                          "receiver": "cometchat-uid-2",
                          "receiverType": "user",
                          "status": "ended",
                          "totalDurationInMinutes": 0.31666666666666665,
                          "totalParticipants": 2,
                          "type": "audio",
                          "mid": "855e1519-1244-4213-8e40-53044c1e9e43",
                          "startedAt": 1692368127,
                          "endedAt": 1692368146,
                          "participants": [
                            {
                              "uid": "cometchat-uid-8",
                              "totalAudioMinutes": 0.26666666666666666,
                              "totalVideoMinutes": 0,
                              "totalDuration": 0.26666666666666666,
                              "deviceId": "70ecae89-b71c-4bb3-8220-b7c99ec1658f@rtc.cometchat.com/hsYWb5ul",
                              "isJoined": true,
                              "joinedAt": 1692368128,
                              "mid": "855e1519-1244-4213-8e40-53044c1e9e43",
                              "state": "ended",
                              "leftAt": 1692368144
                            },
                            {
                              "uid": "cometchat-uid-2",
                              "totalAudioMinutes": 0.23333333333333334,
                              "totalVideoMinutes": 0,
                              "totalDuration": 0.23333333333333334,
                              "deviceId": "c9ed493e-8495-428d-b6ee-b32019cc57ce@rtc.cometchat.com/CKT3xgR4",
                              "isJoined": true,
                              "joinedAt": 1692368132,
                              "mid": "855e1519-1244-4213-8e40-53044c1e9e43",
                              "state": "ended",
                              "leftAt": 1692368146
                            }
                          ]
                        }
                      ],
                      "meta": {
                        "pagination": {
                          "total": 2,
                          "count": 2,
                          "total_pages": 1,
                          "current_page": 1
                        }
                      }
                    }
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        sessionId:
                          type: string
                          example: >-
                            v1.us.31780434a95d45.1692368168aefba73a1e5938ad7a02f8e61ea1c9a287a08aeb
                        totalAudioMinutes:
                          type: number
                          example: 0.31666666666666665
                          default: 0
                        totalVideoMinutes:
                          type: integer
                          example: 0
                          default: 0
                        totalDuration:
                          type: string
                          example: '00:00:19'
                        hasRecording:
                          type: boolean
                          example: false
                          default: true
                        initiatedAt:
                          type: integer
                          example: 1692368168
                          default: 0
                        initiator:
                          type: string
                          example: cometchat-uid-8
                        mode:
                          type: string
                          example: call
                        receiver:
                          type: string
                          example: sivamathewstestgroup
                        receiverType:
                          type: string
                          example: group
                        status:
                          type: string
                          example: ended
                        totalDurationInMinutes:
                          type: number
                          example: 0.31666666666666665
                          default: 0
                        totalParticipants:
                          type: integer
                          example: 2
                          default: 0
                        type:
                          type: string
                          example: audio
                        mid:
                          type: string
                          example: 3f7596ac-854b-484d-b36c-d623e193bd81
                        startedAt:
                          type: integer
                          example: 1692368180
                          default: 0
                        endedAt:
                          type: integer
                          example: 1692368199
                          default: 0
                        participants:
                          type: array
                          items:
                            type: object
                            properties:
                              uid:
                                type: string
                                example: cometchat-uid-2
                              totalAudioMinutes:
                                type: number
                                example: 0.31666666666666665
                                default: 0
                              totalVideoMinutes:
                                type: integer
                                example: 0
                                default: 0
                              isJoined:
                                type: boolean
                                example: true
                                default: true
                              state:
                                type: string
                                example: ended
                              totalDuration:
                                type: number
                                example: 0.31666666666666665
                                default: 0
                              deviceId:
                                type: string
                                example: >-
                                  b7683aaf-090a-4204-8f84-7ddd652923aa@rtc.cometchat.com/ucTKf4eq
                              joinedAt:
                                type: integer
                                example: 1692368180
                                default: 0
                              mid:
                                type: string
                                example: 3f7596ac-854b-484d-b36c-d623e193bd81
                              leftAt:
                                type: integer
                                example: 1692368199
                                default: 0
                  meta:
                    type: object
                    properties:
                      pagination:
                        type: object
                        properties:
                          total:
                            type: integer
                            example: 2
                            default: 0
                          count:
                            type: integer
                            example: 2
                            default: 0
                          total_pages:
                            type: integer
                            example: 1
                            default: 0
                          current_page:
                            type: integer
                            example: 1
                            default: 0
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
components:
  securitySchemes:
    sec0:
      type: apiKey
      in: header
      name: apikey

````