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

# List calls

> Returns a list of calls. Uses cursor pagination ordered by start time (oldest first).



## OpenAPI

````yaml /api-reference/openapi.json get /calls
openapi: 3.1.0
info:
  title: Spott API Reference
  version: '0.1'
servers:
  - url: https://api.gospott.com
security: []
tags: []
paths:
  /calls:
    get:
      tags:
        - Calls
      summary: List calls
      description: >-
        Returns a list of calls. Uses cursor pagination ordered by start time
        (oldest first).
      operationId: getCalls
      parameters:
        - name: limit
          required: false
          in: query
          description: 'Number of calls to return per page (min: 1, max: 50, default: 25).'
          schema:
            minimum: 1
            maximum: 50
            default: 25
            example: 25
            type: integer
        - name: cursor
          required: false
          in: query
          description: >-
            Base64-encoded cursor for pagination. Use the cursor value from a
            previous response to fetch the next page. Omit for the first page.
          schema:
            example: >-
              eyJzdGFydFRpbWUiOiIyMDI0LTExLTA2VDEwOjMwOjAwLjAwMFoiLCJpZCI6ImNhbGwtMTIzIn0=
            type: string
        - name: startsAfter
          required: false
          in: query
          description: >-
            Only include calls whose start time is on or after this date/time
            (inclusive).
          schema:
            $ref: '#/components/schemas/DateISO'
            example: '2024-06-01T00:00:00.000Z'
        - name: startsBefore
          required: false
          in: query
          description: >-
            Only include calls whose start time is on or before this date/time
            (inclusive).
          schema:
            $ref: '#/components/schemas/DateISO'
            example: '2024-06-30T23:59:59.999Z'
      responses:
        '200':
          description: >-
            Successfully retrieved calls. Returns items with pagination info
            containing the cursor for the next page.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCallsResponseDto'
        '400':
          description: >-
            Bad request - invalid query parameters (e.g., limit out of range,
            invalid date format)
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ExceptionBaseDto'
                  - type: object
                    properties:
                      statusCode:
                        type: number
                        example: 400
                      message:
                        type: string
                        example: Limit must be between 1 and 50
                      error:
                        type: string
                        example: Bad Request
        '401':
          description: Unauthorized - invalid or missing authentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseDto'
        '500':
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseDto'
      security:
        - x-api-key: []
components:
  schemas:
    DateISO:
      id: DateISO
      format: date-time
      anyOf:
        - type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
        - type: string
          format: date
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
    GetCallsResponseDto:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/CallDto'
        pagination:
          $ref: '#/components/schemas/CallCursorPaginationDto'
      required:
        - items
        - pagination
      id: PrivateGetCallsResponseDto
    ExceptionBaseDto:
      type: object
      properties:
        status:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        message:
          type: string
        requestId:
          type: string
      required:
        - status
        - message
        - requestId
      id: ExceptionBaseDto
    CallDto:
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/CallType'
        provider:
          $ref: '#/components/schemas/CallProvider'
        startTime:
          $ref: '#/components/schemas/DateISO'
        endTime:
          anyOf:
            - $ref: '#/components/schemas/DateISO'
            - type: 'null'
        answeredAt:
          anyOf:
            - $ref: '#/components/schemas/DateISO'
            - type: 'null'
        isOngoing:
          type: boolean
        fromNumber:
          type: string
        toNumber:
          type: string
        transcriptId:
          anyOf:
            - type: string
            - type: 'null'
        recordingAttachmentId:
          anyOf:
            - type: string
            - type: 'null'
        participants:
          type: array
          items:
            $ref: '#/components/schemas/CallParticipantDto'
      required:
        - id
        - type
        - provider
        - startTime
        - endTime
        - answeredAt
        - isOngoing
        - fromNumber
        - toNumber
        - transcriptId
        - recordingAttachmentId
        - participants
      id: PrivateCallDto
    CallCursorPaginationDto:
      type: object
      properties:
        cursor:
          type:
            - string
            - 'null'
      required:
        - cursor
      id: PrivateCallCursorPaginationDto
    CallType:
      type: string
      enum:
        - CALL_INCOMING
        - CALL_OUTGOING
      id: PrivateCallType
    CallProvider:
      type: string
      enum:
        - TELNYX
        - AIRCALL
        - RINGCENTRAL
        - RINGOVER
        - VOIPPLAY
        - DIALPAD
      id: PrivateCallProvider
    CallParticipantDto:
      type: object
      properties:
        name:
          anyOf:
            - type: string
            - type: 'null'
        role:
          $ref: '#/components/schemas/CallParticipantRole'
        detail:
          anyOf:
            - $ref: '#/components/schemas/CallInteractionContactDto'
            - type: 'null'
      required:
        - name
        - role
        - detail
      id: PrivateCallParticipantDto
    CallParticipantRole:
      type: string
      enum:
        - from
        - to
      id: PrivateCallParticipantRole
    CallInteractionContactDto:
      oneOf:
        - $ref: '#/components/schemas/CallInteractionUserContactDto'
        - $ref: '#/components/schemas/CallInteractionCandidateContactDto'
        - $ref: '#/components/schemas/CallInteractionClientContactDto'
        - $ref: '#/components/schemas/CallInteractionUnknownContactDto'
      id: PrivateCallInteractionContactDto
    CallInteractionUserContactDto:
      type: object
      properties:
        type:
          type: string
          enum:
            - user
        id:
          type: string
      required:
        - type
        - id
      id: PrivateCallInteractionUserContactDto
    CallInteractionCandidateContactDto:
      type: object
      properties:
        type:
          type: string
          enum:
            - candidate
        id:
          type: string
      required:
        - type
        - id
      id: PrivateCallInteractionCandidateContactDto
    CallInteractionClientContactDto:
      type: object
      properties:
        type:
          type: string
          enum:
            - clientContact
        candidateId:
          type: string
        companyId:
          type: string
      required:
        - type
        - candidateId
        - companyId
      id: PrivateCallInteractionClientContactDto
    CallInteractionUnknownContactDto:
      type: object
      properties:
        type:
          type: string
          enum:
            - unknown
        displayName:
          anyOf:
            - type: string
            - type: 'null'
      required:
        - type
        - displayName
      id: PrivateCallInteractionUnknownContactDto
  securitySchemes:
    x-api-key:
      type: apiKey
      name: x-api-key
      in: header
      description: >-
        API key for authentication. Get your API key from Settings → API Keys in
        your Spott dashboard.

````