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

# Get batch call

> Returns the batch and its current `status`. Poll it after [Create batch call](/api-reference/batch-calls/create-batch-call) to follow parsing and calling.



## OpenAPI

````yaml /api-reference/rest/openapi.yaml get /v1/batch-calls/{batchId}
openapi: 3.1.0
info:
  title: Zero Runtime REST API
  version: '1.0'
  description: >-
    Create, configure, version and deploy agents, and wire SIP telephony to
    them.
servers:
  - url: https://api.zeroruntime.ai
security:
  - token: []
tags:
  - name: Agents
  - name: Versions
  - name: Deployment
  - name: Phone numbers
  - name: Routing rules
  - name: Calls
  - name: Batch calls
  - name: Knowledge bases
  - name: Knowledge base folders
paths:
  /v1/batch-calls/{batchId}:
    parameters:
      - name: batchId
        in: path
        required: true
        schema:
          type: string
        example: btcl_k3x9q2
    get:
      tags:
        - Batch calls
      summary: Get batch call
      description: >-
        Returns the batch and its current `status`. Poll it after [Create batch
        call](/api-reference/batch-calls/create-batch-call) to follow parsing
        and calling.
      responses:
        '200':
          description: The batch.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchCall'
              example:
                batchId: btcl_k3x9q2
                batchName: October renewals
                description: Renewal reminders for gold and silver plans
                phoneNumberId: 6f1d2c3a-8b4e-4f7a-9c21-0d5e6b7a8c90
                phoneNumber: '+14155550100'
                routingRuleId: rr_2554md
                status: running
                timing: scheduled
                timezone: Asia/Kolkata
                scheduledDate: '2026-10-14'
                scheduledTime: '10:00'
                retry:
                  enabled: true
                  retryOn:
                    - not-answered
                    - failed
                  retryDelays:
                    - 600
                    - 3600
                  maxAttempts: 2
                recordsUploaded: 250
                parseError: null
                file:
                  filename: customers.csv
                  extension: .csv
                  key: batchcall/btcl_k3x9q2/1760261400000-customers.csv
                timestamp: 1760416200
                createdAt: '2026-10-12T09:30:00.000Z'
                updatedAt: '2026-10-14T04:30:02.000Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: The batch isn't yours or is deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Message'
              example:
                message: Batch call not found
components:
  schemas:
    BatchCall:
      type: object
      properties:
        batchId:
          type: string
          example: btcl_k3x9q2
        batchName:
          type: string
          description: The `name` you sent.
          example: October renewals
        description:
          type: string
        phoneNumberId:
          type: string
          description: The number calls are made from.
        phoneNumber:
          type: string
          description: That number in E.164.
          example: '+14155550100'
        routingRuleId:
          type: string
          description: The outbound routing rule in use.
          example: rr_2554md
        status:
          type: string
          enum:
            - parsing
            - parse_failed
            - scheduled
            - running
            - cancelling
            - cancelled
            - completed
          description: >
            Without a `schedule`, a batch goes straight from `parsing` to
            `running`.


            - `parsing`: the file is being read. No calls yet.

            - `parse_failed`: the file couldn't be used, and `parseError` says
            why. Fix the file and create a new batch.

            - `scheduled`: parsed, waiting for its start time.

            - `running`: calls are being placed.

            - `cancelling`: a cancel is in progress.

            - `cancelled`: stopped before every number was called.

            - `completed`: every number has been called, retries included.
        timing:
          type: string
          enum:
            - immediate
            - scheduled
          description: '`scheduled` when you sent a `schedule`, otherwise `immediate`.'
        timezone:
          type: string
          example: Asia/Kolkata
        scheduledDate:
          type: string
          description: '`schedule.date`.'
          example: '2026-10-14'
        scheduledTime:
          type: string
          description: '`schedule.time`.'
          example: '10:00'
        retry:
          type: object
          properties:
            enabled:
              type: boolean
              description: '`true` when you sent `retry`.'
            retryOn:
              type: array
              items:
                type: string
                enum:
                  - failed
                  - not-answered
                  - rejected
                  - missed
                  - abandoned
            retryDelays:
              type: array
              items:
                type: integer
                minimum: 0
              description: Seconds before each retry.
            maxAttempts:
              type: integer
              description: Number of retries
              the length of `retryDelays`.: null
        recordsUploaded:
          type: integer
          description: Phone numbers read from the file. `0` until parsing finishes.
        parseError:
          type:
            - string
            - 'null'
          description: Why parsing failed. Set when `status` is `parse_failed`.
        file:
          type: object
          description: The uploaded file.
          properties:
            filename:
              type: string
              example: customers.csv
            extension:
              type: string
              example: .csv
            key:
              type: string
        timestamp:
          type: integer
          description: Start time as a Unix timestamp in seconds. For an immediate batch
          its creation time.: null
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Message:
      type: object
      properties:
        message:
          type: string
    Error:
      type: object
      properties:
        error:
          type: string
  responses:
    Unauthorized:
      description: Missing or invalid `Authorization` header.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    token:
      type: apiKey
      in: header
      name: Authorization
      description: Your API token, sent raw (no `Bearer` prefix).
      x-default: <auth-token>

````

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