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

# List calls

> Returns a paginated list of calls, ordered by start time (newest first). Optionally filter by status. `status` is the call lifecycle/carrier state; use `disposition` on each call for the final outcome such as `voicemail`, `busy`, or `no_answer`.



## OpenAPI

````yaml /openapi.json get /calls
openapi: 3.1.0
info:
  title: Vocobase Partner API
  version: '2.0'
  description: >-
    API for managing voice AI agents, documents, and calls on the Vocobase
    platform.
servers:
  - url: https://api.vocobase.com/api/v2
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Config
    description: >-
      Read and update partner configuration, webhook settings, and telephony
      credentials.
  - name: Agents
    description: Create, read, update, and delete voice AI agents.
  - name: Voices
    description: >-
      List voice tiers, available voices, and stream preview audio for agent
      configuration.
  - name: Documents
    description: Upload, manage, and delete knowledge base documents.
  - name: Agent Documents
    description: Link and unlink documents to agents for knowledge base integration.
  - name: Calls
    description: Initiate outbound calls and view call history.
  - name: Phone Numbers
    description: >-
      Import DIDs, assign agents for inbound routing, and re-sync carrier
      Application bindings.
  - name: Inbound Routing Policies
    description: >-
      Define pre-answer routing decisions for inbound calls before AI sessions
      are created.
  - name: Telephony Connections
    description: Create, list, rename, and disconnect named V2 telephony connections.
  - name: VoiceLink Management
    description: Manage VoiceLink reseller clients, DID mapping, and readiness sync.
  - name: Projects
    description: Organize agents into projects. Every agent belongs to exactly one project.
  - name: Dictionaries
    description: Speech-recognition dictionary CRUD and agent attachment.
  - name: Sessions
    description: Browser-initiated WebRTC voice sessions for in-app voice agents.
paths:
  /calls:
    get:
      tags:
        - Calls
      summary: List calls
      description: >-
        Returns a paginated list of calls, ordered by start time (newest first).
        Optionally filter by status. `status` is the call lifecycle/carrier
        state; use `disposition` on each call for the final outcome such as
        `voicemail`, `busy`, or `no_answer`.
      operationId: listCalls
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
          description: Number of calls to return.
        - name: offset
          in: query
          schema:
            type: integer
            minimum: 0
            default: 0
          description: Number of calls to skip.
        - name: status
          in: query
          schema:
            type: string
            enum:
              - pending
              - ringing
              - in_progress
              - completed
              - failed
              - no_answer
              - busy
              - canceled
          description: >-
            Filter by call lifecycle status (case-insensitive). Voicemail is
            returned as `disposition: "voicemail"`, not as a status.
      responses:
        '200':
          description: List of calls.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    type: object
                    properties:
                      calls:
                        type: array
                        items:
                          $ref: '#/components/schemas/Call'
                      total:
                        type: integer
                      limit:
                        type: integer
                      offset:
                        type: integer
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    Call:
      type: object
      properties:
        call_id:
          type: string
          format: uuid
        agent_id:
          type: string
          format: uuid
        session_id:
          type:
            - string
            - 'null'
          format: uuid
        direction:
          type: string
          enum:
            - outbound
            - inbound
        from_number:
          type: string
        to_number:
          type: string
        status:
          type: string
          enum:
            - pending
            - ringing
            - in_progress
            - completed
            - failed
            - no_answer
            - busy
            - canceled
          description: >-
            Call lifecycle/carrier status. Voicemail is exposed through
            `disposition`, not `status`.
        disposition:
          type:
            - string
            - 'null'
          enum:
            - completed
            - voicemail
            - user_hangup_no_speech
            - no_answer
            - busy
            - canceled
            - blocked
            - failed
            - transferred
            - null
          description: >-
            Final call outcome derived from carrier signals and bot-side
            signals. Use `voicemail` to detect carrier or bot voicemail
            outcomes.
        answered_by:
          type:
            - string
            - 'null'
          enum:
            - human
            - machine
            - unknown
            - not_answered
            - null
          description: >-
            Best-known answer classification. `machine` indicates an answering
            machine or voicemail.
        hangup_cause:
          type:
            - string
            - 'null'
          description: Raw normalized carrier hangup cause when available.
        hangup_source:
          type:
            - string
            - 'null'
          enum:
            - caller
            - callee
            - system
            - api
            - carrier
            - error
            - unknown
            - null
          description: Best-known party or system that ended the call.
        bill_duration_seconds:
          type:
            - integer
            - 'null'
          description: Carrier-billed duration in seconds when available.
        provider:
          type:
            - string
            - 'null'
          enum:
            - mcube
            - twilio
            - exotel
            - plivo
            - vobiz
            - tata_smartflo
            - sip
            - voicelink
            - null
        connection_id:
          type:
            - string
            - 'null'
          format: uuid
          description: Telephony connection used for the call, when applicable.
        duration_seconds:
          type:
            - integer
            - 'null'
        error_message:
          type:
            - string
            - 'null'
        started_at:
          type: string
          format: date-time
        ended_at:
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          const: false
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
      required:
        - success
        - error
  responses:
    ValidationError:
      description: Validation error in request body or parameters.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: VALIDATION_ERROR
              message: agent_name is required and must be max 50 characters
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: UNAUTHORIZED
              message: Invalid or missing API key
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: INTERNAL_ERROR
              message: An unexpected error occurred
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key in format: `rg_live_xxxx`. Pass as a Bearer token in the
        Authorization header.

````