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

# Get a batch

> Return one batch with its individual call records and a summary. Records
are newest first, 20 per page.




## OpenAPI

````yaml /api-reference/openapi.yaml get /batches/{id}
openapi: 3.1.0
info:
  title: Outbound Calls API
  version: 1.0.0-beta
  description: |
    REST API for placing AI-powered outbound calls to your contacts. Place a
    single call or a batch, personalize each call's prompt, and review the
    results.

    This reference is in **beta**: the endpoints below are live in production,
    but the reference itself is still being expanded to cover the rest of the
    platform API.
servers:
  - url: https://aipro.placetel.de/api/v1/outbound
security:
  - bearerAuth: []
tags:
  - name: Calls
    description: Place outbound calls.
  - name: Batches
    description: Review the outcome of calls you placed.
  - name: Consents
    description: Manage individual call records before they are dialed.
paths:
  /batches/{id}:
    get:
      tags:
        - Batches
      summary: Get a batch
      description: |
        Return one batch with its individual call records and a summary. Records
        are newest first, 20 per page.
      operationId: getBatch
      parameters:
        - name: id
          in: path
          required: true
          description: The `batch_id` returned when you placed the call(s).
          schema:
            type: string
            format: uuid
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
      responses:
        '200':
          description: Batch detail.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    examples:
                      - true
                  batch_id:
                    type: string
                    format: uuid
                  agent_name:
                    type: string
                    nullable: true
                  agent_number:
                    type: string
                  batch_created_at:
                    type: string
                    format: date-time
                  consents:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          description: The `consent_id` of this call record.
                        phone:
                          type: string
                          examples:
                            - '+491761234567'
                        status:
                          type: string
                          enum:
                            - pending
                            - approved
                            - rejected
                            - expired
                            - cancelled
                        consent_method:
                          type: string
                          examples:
                            - direct
                        auto_call_sid:
                          type: string
                          nullable: true
                          description: Telephony call identifier, once dialed.
                        auto_call_error:
                          type: string
                          nullable: true
                        conversation_id:
                          type: integer
                          nullable: true
                          description: |
                            The conversation this call produced. Open it in your
                            dashboard for the transcript.
                        updated_at:
                          type: string
                          format: date-time
                  total_pages:
                    type: integer
                  current_page:
                    type: integer
                  summary:
                    type: object
                    properties:
                      total:
                        type: integer
                      approved:
                        type: integer
                      called:
                        type: integer
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Batch not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                success: false
                error: Batch not found
components:
  responses:
    Unauthorized:
      description: Missing or invalid API token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Outbound calling is not enabled for your account.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        success:
          type: boolean
          examples:
            - false
        error:
          type: string
          description: Description of the issue, in English.
        error_type:
          type: string
          description: Machine-readable error category, present on limit-related errors.
        detail:
          type: string
          description: Where to go next, present on rate-limit errors.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        Generate (or rotate) your token on the **Outbound Calls** page in your
        dashboard. The token is shown once - store it securely; rotating it
        invalidates the previous token. A token only reaches your own agents and
        data.

````