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

# List batches

> Lists batches for the authenticated tenant, most recent first.



## OpenAPI

````yaml /openapi.json get /api/v1/batches
openapi: 3.1.0
info:
  title: Eclatira API
  description: >-
    Programmatically create calls and batches, manage agents/tools/knowledge,
    and retrieve conversation analytics.
  contact:
    name: Eclatira Support
    email: contact@eclatira.com
  version: 1.0.0
servers:
  - url: https://app.eclatira.com
    description: API Server
security: []
tags:
  - name: developer-api
    description: >-
      The API-key-authenticated developer surface: calls, batches, and agents.
      Authenticate with `Authorization: Bearer ek_...`.
  - name: Calls
    description: Place outbound calls with an agent, check status, list history.
  - name: Batches
    description: 'Outbound call campaigns: create, list, inspect, cancel, retry.'
  - name: Agents
    description: Create and manage the agents that place and receive calls.
  - name: Tools
    description: Custom actions an agent can call mid-call, attached per-agent.
  - name: MCP Servers
    description: >-
      Connect an agent to an external MCP (Model Context Protocol) server so it
      can call that server's tools, with static or OAuth auth.
  - name: Knowledge Base
    description: Upload files and index them into an agent's knowledge base.
  - name: Realtime
    description: >-
      Mint a short-lived session token to open a live voice/video WebSocket
      connection: the only supported way for an API-key holder to authenticate
      into /ws/{user_id}.
  - name: Webhooks
    description: >-
      Register a durable callback URL to receive call.completed and
      batch.completed events for every matching workspace event, and fetch the
      tenant signing secret used to verify X-Webhook-Signature.
  - name: developer-api-keys
    description: >-
      Account-management routes (create/list/revoke API keys), authenticated via
      dashboard login, not an API key, since they mint the credentials the rest
      of the developer API uses.
paths:
  /api/v1/batches:
    get:
      tags:
        - Batches
        - developer-api
      summary: List batches
      description: Lists batches for the authenticated tenant, most recent first.
      operationId: listBatches
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 50
            title: Limit
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            default: 0
            title: Offset
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1BatchListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    V1BatchListResponse:
      properties:
        batches:
          items:
            $ref: '#/components/schemas/V1BatchSummary'
          type: array
          title: Batches
        total:
          type: integer
          title: Total
        has_more:
          type: boolean
          title: Has More
      type: object
      required:
        - batches
        - total
        - has_more
      title: V1BatchListResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    V1BatchSummary:
      properties:
        batch_id:
          type: string
          title: Batch Id
        agent_id:
          type: string
          title: Agent Id
        name:
          type: string
          title: Name
        status:
          type: string
          title: Status
        provider:
          anyOf:
            - type: string
            - type: 'null'
          title: Provider
        total:
          type: integer
          title: Total
        completed_count:
          type: integer
          title: Completed Count
        failed_count:
          type: integer
          title: Failed Count
        voicemail_count:
          type: integer
          title: Voicemail Count
        in_progress_count:
          type: integer
          title: In Progress Count
        created_at:
          type: string
          format: date-time
          title: Created At
        scheduled_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Scheduled At
      type: object
      required:
        - batch_id
        - agent_id
        - name
        - status
        - total
        - completed_count
        - failed_count
        - voicemail_count
        - in_progress_count
        - created_at
      title: V1BatchSummary
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        A long-lived, privileged API key (`ek_...` prefix), minted once from the
        dashboard. Intended for trusted server-side use only; never expose it in
        client-side code. Send as `Authorization: Bearer ek_...`. Required by
        every Calls, Batches, Agents, Tools, MCP Servers, Documents, and
        Realtime route.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.