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

# List calls

> Returns calls for the specified agent with optional filtering.
Results are ordered by `created_at` descending (newest first).
Soft-deleted calls are excluded by default. Calls permanently deleted in
the Dashboard trash are never returned, not even with `include_deleted=true`.




## OpenAPI

````yaml get /v1/agents/{agentId}/calls
openapi: 3.1.0
info:
  title: TalkPilot API
  version: 1.0.0
  description: >
    The TalkPilot API allows you to programmatically manage your call center
    agents,

    employees, forwarding slots, knowledge base, and more.


    ## Authentication


    All API requests require an API key passed via the `X-API-Key` header:


    ```

    X-API-Key: tp_live_abc123def456...

    ```


    An API key can reach every organization its creator is a member of (see

    `GET /v1/organization`) and can be restricted to specific agents and
    permissions.

    Create and manage keys in the TalkPilot Dashboard under **Settings > API**

    (Dev-Admin only).


    ## Rate Limiting


    Default limits per API key: **60 requests/minute** and **1,000
    requests/hour**

    (both enforced, both configurable per key).


    Rate limit headers are included in every response to a request authenticated

    with an API key (Dashboard JWT requests are not rate limited):

    - `X-RateLimit-Limit` — Max requests per minute

    - `X-RateLimit-Remaining` — Remaining requests in the current minute window

    - `X-RateLimit-Reset` — Unix timestamp roughly 60 seconds in the future


    When rate limited, the API returns `429 Too Many Requests` with
    `Retry-After: 60`

    (minute window) or `Retry-After: 3600` (hour window).


    ## Pagination


    List endpoints support pagination via query parameters:

    - `page` — Page number (default: 1)

    - `limit` — Items per page (default: 20, max: 100)


    Paginated responses include a `pagination` object with `page`, `limit`,
    `total`, and `pages`.


    ## Error Format


    All errors follow a consistent format:


    ```json

    {
      "error": {
        "code": "VALIDATION_ERROR",
        "message": "Human-readable description",
        "details": [{ "field": "name", "message": "Required" }],
        "request_id": "req_abc123"
      }
    }

    ```
  contact:
    name: TalkPilot Support
    email: support@talkpilot.io
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.talkpilot.io
    description: Production
security:
  - apiKey: []
tags:
  - name: Health
    description: API health and status
  - name: Agents
    description: Manage AI agent configurations
  - name: Workflow
    description: Multi-state conversation flow of an agent
  - name: Tools
    description: Manage agent tools (HTTP requests, call transfers, etc.)
  - name: Employees
    description: Manage employees linked to agents
  - name: Contacts
    description: >-
      Customer contacts (customer_database) per agent — the voice agent
      recognises callers and greets them by name or tag from here
  - name: Forwarding Slots
    description: Manage call forwarding slot assignments
  - name: Knowledge Base
    description: Manage agent knowledge base documents
  - name: Calls
    description: Read call records and transcripts
  - name: Organization
    description: Organization-level settings
  - name: API Keys
    description: Manage API keys (Dashboard JWT auth only; dev_admin)
paths:
  /v1/agents/{agentId}/calls:
    get:
      tags:
        - Calls
      summary: List calls
      description: >
        Returns calls for the specified agent with optional filtering.

        Results are ordered by `created_at` descending (newest first).

        Soft-deleted calls are excluded by default. Calls permanently deleted in

        the Dashboard trash are never returned, not even with
        `include_deleted=true`.
      operationId: listCalls
      parameters:
        - $ref: '#/components/parameters/AgentId'
        - $ref: '#/components/parameters/PageParam'
        - $ref: '#/components/parameters/LimitParam'
        - name: done
          in: query
          description: Filter by completion status
          schema:
            type: boolean
        - name: from
          in: query
          description: Filter calls created after this date (ISO 8601)
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          description: Filter calls created before this date (ISO 8601)
          schema:
            type: string
            format: date-time
        - name: phone_number
          in: query
          description: Filter by caller phone number (exact match)
          schema:
            type: string
        - name: search
          in: query
          description: Search in customer name, phone number, or call summary
          schema:
            type: string
        - name: include_deleted
          in: query
          description: Include soft-deleted calls
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: List of calls
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Call'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
              example:
                data:
                  - id: call-uuid-1
                    call_id: lk_call_abc123
                    customer_name: Hans Meier
                    customer_request: 'Frage zu Rechnung #1234'
                    phone_number: '+491701234567'
                    duration: 180
                    done: true
                    general_success: true
                    disconnection_reason: user_hangup
                    call_summary: Kunde fragte nach Rechnung...
                    employee: Max Mustermann
                    note: null
                    agent_id: 550e8400-e29b-41d4-a716-446655440000
                    created_at: '2026-03-19T10:30:00Z'
                pagination:
                  page: 1
                  limit: 20
                  total: 150
                  pages: 8
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    AgentId:
      name: agentId
      in: path
      required: true
      description: Agent UUID
      schema:
        type: string
        format: uuid
    PageParam:
      name: page
      in: query
      description: Page number
      schema:
        type: integer
        minimum: 1
        default: 1
    LimitParam:
      name: limit
      in: query
      description: Items per page
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
  schemas:
    Call:
      type: object
      description: Call summary (list view — no transcript or audio)
      properties:
        id:
          type: string
          format: uuid
        call_id:
          type:
            - string
            - 'null'
          description: External call ID (e.g. LiveKit)
        customer_name:
          type:
            - string
            - 'null'
        customer_request:
          type:
            - string
            - 'null'
        phone_number:
          type:
            - string
            - 'null'
        duration:
          type:
            - integer
            - 'null'
          description: Call duration in seconds
        done:
          type:
            - boolean
            - 'null'
        general_success:
          type:
            - boolean
            - 'null'
        disconnection_reason:
          type:
            - string
            - 'null'
          enum:
            - user_hangup
            - agent_hangup
            - call_transfer
            - unknown
            - busy
            - no_answer
            - dial_error
          description: '`busy`, `no_answer` and `dial_error` occur on outbound calls only'
        call_summary:
          type:
            - string
            - 'null'
        employee:
          type:
            - string
            - 'null'
          description: Assigned employee name
        note:
          type:
            - string
            - 'null'
        agent_id:
          type:
            - string
            - 'null'
          format: uuid
        is_purged:
          type: boolean
        deleted_at:
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Pagination:
      type: object
      properties:
        page:
          type: integer
        limit:
          type: integer
        total:
          type: integer
        pages:
          type: integer
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              enum:
                - VALIDATION_ERROR
                - UNAUTHORIZED
                - FORBIDDEN
                - AGENT_NOT_ACCESSIBLE
                - NOT_FOUND
                - CONFLICT
                - RATE_LIMITED
                - INTERNAL_ERROR
            message:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  field:
                    type: string
                  message:
                    type: string
            request_id:
              type: string
  responses:
    Unauthorized:
      description: Missing or invalid authentication
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Invalid or missing API key
              request_id: req_abc123
    Forbidden:
      description: >
        Insufficient permissions (`FORBIDDEN`), or the agent is outside the
        key's

        `allowed_agent_ids` (`AGENT_NOT_ACCESSIBLE`)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            missingPermission:
              value:
                error:
                  code: FORBIDDEN
                  message: 'API key lacks required permission: agents:write'
                  request_id: req_abc123
            agentNotAccessible:
              value:
                error:
                  code: AGENT_NOT_ACCESSIBLE
                  message: API key does not have access to this agent
                  request_id: req_abc123
    RateLimited:
      description: Too many requests for this API key (60/minute or 1,000/hour by default)
      headers:
        Retry-After:
          description: >-
            Seconds to wait before retrying — 60 for the minute window, 3600 for
            the hour window
          schema:
            type: integer
        X-RateLimit-Limit:
          schema:
            type: integer
        X-RateLimit-Remaining:
          schema:
            type: integer
        X-RateLimit-Reset:
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: RATE_LIMITED
              message: Rate limit exceeded. Try again in 60 seconds.
              request_id: req_abc123
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: |
        API key for external access. Format: `tp_live_<32-hex-chars>`.
        Create keys in the TalkPilot Dashboard under Settings > API.

````