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

# List Batch Calls

> Retrieve all batch calling campaigns.



## OpenAPI

````yaml /api-reference/openapi.json get /batch-calls
openapi: 3.1.0
info:
  title: Truedy API
  description: >-
    Truedy Public API - Build voice AI agents and make automated phone calls.


    ## Authentication

    All requests require **Authorization: Bearer <your_api_key>**.

    Get your API key from the [Truedy Dashboard](https://app.truedy.ai).


    ## Response Format

    All successful responses follow this format:

    ```json

    {
      "data": { /* resource or list of resources */ },
      "meta": {
        "request_id": "req_xxx",
        "ts": "2026-03-03T20:30:21.310278Z"
      },
      "pagination": { /* optional, for list endpoints */ }
    }

    ```


    ## Error Handling

    Errors return appropriate HTTP status codes with structured error messages.
    Always check the `error` field in the response body for details.
  version: 1.0.0
servers:
  - url: https://api.truedy.ai/api/public/v1
    description: Truedy Public API
security:
  - BearerAuth: []
paths:
  /batch-calls:
    get:
      tags:
        - Batch Calls
      summary: List Batch Calls
      description: Retrieve all batch calling campaigns.
      operationId: list_batch_calls
      parameters:
        - name: status
          in: query
          required: false
          description: Filter by status
          schema:
            type: string
            enum:
              - draft
              - scheduled
              - active
              - paused
              - completed
              - failed
              - cancelled
        - name: limit
          in: query
          required: false
          description: Maximum results per page
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
        - name: offset
          in: query
          required: false
          description: Number of results to skip
          schema:
            type: integer
            minimum: 0
            default: 0
      responses:
        '200':
          description: List of batch calls
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - meta
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BatchCallResponse'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                  pagination:
                    $ref: '#/components/schemas/PaginationInfo'
              example:
                data:
                  - id: batch_c3d4e5f6
                    name: Q2 Outreach Campaign
                    status: running
                    agent_id: agt_f9447372
                    from_number: '+18005559876'
                    schedule_type: immediate
                    scheduled_at: null
                    timezone: America/New_York
                    concurrency: 5
                    retry_attempts: 2
                    total_contacts: 500
                    called: 312
                    completed: 298
                    failed: 14
                    pending: 188
                    created_at: '2026-04-01T09:00:00Z'
                    updated_at: '2026-04-05T10:22:00Z'
                  - id: batch_d4e5f6g7
                    name: Re-engagement Campaign
                    status: completed
                    agent_id: agt_f9447372
                    from_number: '+18005559876'
                    schedule_type: immediate
                    scheduled_at: null
                    timezone: America/New_York
                    concurrency: 5
                    retry_attempts: 2
                    total_contacts: 500
                    called: 312
                    completed: 298
                    failed: 14
                    pending: 188
                    created_at: '2026-04-01T09:00:00Z'
                    updated_at: '2026-04-05T10:22:00Z'
                meta:
                  request_id: req_32e7531c
                  ts: '2026-04-05T10:22:00Z'
                pagination:
                  total: 24
                  limit: 50
                  offset: 0
                  has_more: false
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    BatchCallResponse:
      type: object
      required:
        - id
        - name
        - agent_id
        - status
        - created_at
      properties:
        id:
          type: string
          description: Unique batch call identifier
          example: batch_m1n2o3p4
        name:
          type: string
          description: Campaign name
          example: March follow-up campaign
        agent_id:
          type: string
          description: Agent ID used for this batch
          example: agt_f9447372
        status:
          type: string
          enum:
            - draft
            - scheduled
            - active
            - paused
            - completed
            - failed
            - cancelled
          description: Campaign status
          example: active
        phone_number_ids:
          type: array
          items:
            type: string
          description: Phone numbers assigned to this batch
          example:
            - num_11111111-1111-1111-1111-111111111111
        phone_rotation_strategy:
          type: string
          enum:
            - random
            - sequential
            - round_robin
          description: How to rotate between phone numbers
          example: random
        total_contacts:
          type: integer
          description: Total contacts in this batch
          example: 500
        completed_contacts:
          type: integer
          description: Contacts completed (called)
          example: 350
        successful_contacts:
          type: integer
          description: Successfully completed calls
          example: 280
        failed_contacts:
          type: integer
          description: Failed calls
          example: 70
        voicemail_contacts:
          type: integer
          description: Voicemail reached
          example: 45
        no_answer_contacts:
          type: integer
          description: No answer
          example: 25
        total_cost_usd:
          type: number
          description: Total cost in USD
          example: 147.5
        average_duration_seconds:
          type: integer
          description: Average call duration
          example: 187
        schedule_type:
          type: string
          enum:
            - immediate
            - scheduled
          description: Schedule type
          example: scheduled
        scheduled_at:
          format: date-time
          description: When campaign is scheduled to start
          example: '2026-03-20T09:00:00Z'
          type:
            - string
            - 'null'
        max_calls_per_day:
          description: Maximum calls per day
          example: 500
          type:
            - integer
            - 'null'
        created_at:
          type: string
          format: date-time
          description: When created
          example: '2026-03-05T10:00:00.000000Z'
        updated_at:
          format: date-time
          description: When last updated
          example: '2026-03-05T15:30:00.000000Z'
          type:
            - string
            - 'null'
    ResponseMeta:
      type: object
      required:
        - request_id
        - ts
      properties:
        request_id:
          type: string
          description: Unique request identifier for debugging and support
          example: req_32e7531c-8
        ts:
          type: string
          format: date-time
          description: Server timestamp when the response was generated
          example: '2026-03-03T20:30:21.310278Z'
    PaginationInfo:
      type: object
      required:
        - total
        - limit
        - offset
        - has_more
      properties:
        total:
          type: integer
          description: Total number of items matching the query
          example: 156
        limit:
          type: integer
          description: Maximum items returned per page
          example: 50
        offset:
          type: integer
          description: Number of items skipped from the beginning
          example: 0
        has_more:
          type: boolean
          description: Whether more items exist after this page
          example: true
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Error code
              example: not_found
            message:
              type: string
              description: Human-readable error message
              example: The requested resource does not exist
            details:
              description: Additional error context
              example:
                resource: agent
                id: agt_invalid
              type:
                - object
                - 'null'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key authentication. Include your API key in the Authorization
        header: Bearer <your_api_key>

````