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

# Get campaign details

> Retrieve a single campaign by id, scoped to the authenticated account.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/campaigns/{campaign_id}
openapi: 3.0.3
info:
  title: TopCalls Voice API
  description: >
    TopCalls Voice Gateway API for creating and managing AI-powered phone calls.


    ## Authentication


    All API requests require authentication. Include your API key in the
    `Authorization` header:


    ```

    Authorization: Bearer tc_live_xxxxx

    ```


    ## Rate Limits


    Direct call creation via `POST /v1/calls` is limited to your account's

    `max_calls_per_minute` setting (default: 20) per minute. Exceeding it
    returns

    `429 Too Many Requests` with a `Retry-After` header.

    All endpoints are additionally subject to a flat limit of 120 requests per

    minute per account (all methods).


    On a `429`, wait for the number of seconds in the `Retry-After` header, then

    retry the same request. For automated clients, back off progressively on

    repeated `429`s. Limits are per account and are shared by all API keys.


    ## Error Format


    All errors follow RFC 7807 Problem+JSON format:


    ```json

    {
      "type": "https://api.topcalls.ai/errors/insufficient_quota",
      "title": "Insufficient Quota",
      "status": 402,
      "detail": "Not enough remaining call minutes to admit this call"
    }

    ```
  version: 1.0.0
  contact:
    name: TopCalls Support
    url: https://topcalls.ai
  license:
    name: Proprietary
servers:
  - url: https://api.topcalls.ai
    description: Production
security: []
tags:
  - name: Calls
    description: Create and manage phone calls
  - name: Phone Numbers
    description: Manage phone numbers and carriers
  - name: Account
    description: Account information and usage
  - name: Webhooks
    description: Webhook configuration and events
  - name: Configuration
    description: Available AI models, voices, and platform capabilities
paths:
  /v1/campaigns/{campaign_id}:
    get:
      tags:
        - Campaigns
      summary: Get campaign details
      description: Retrieve a single campaign by id, scoped to the authenticated account.
      operationId: getCampaign
      parameters:
        - name: campaign_id
          in: path
          required: true
          description: Campaign UUID
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Campaign details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Campaign'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Campaign not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      security:
        - bearerAuth: []
components:
  schemas:
    Campaign:
      type: object
      description: |
        Campaign record. Returned by GET /v1/campaigns and
        GET /v1/campaigns/{campaign_id}. Projected to this documented field
        set; additional internal columns are never included.
      additionalProperties: true
      properties:
        id:
          type: string
          format: uuid
        account_id:
          type: string
          format: uuid
        name:
          type: string
        description:
          type: string
          nullable: true
        status:
          type: string
          enum:
            - draft
            - scheduled
            - running
            - paused
            - completed
            - failed
            - cancelled
        timezone:
          type: string
          nullable: true
          description: >-
            IANA timezone name used to interpret dispatch hours and
            schedule_time.
        schedule_time:
          type: string
          format: date-time
          nullable: true
        dispatch_hours_start:
          type: string
          nullable: true
          description: Local time of day dispatch may begin, HH:MM:SS.
        dispatch_hours_end:
          type: string
          nullable: true
          description: Local time of day dispatch must stop, HH:MM:SS.
        dispatch_weekdays:
          type: array
          items:
            type: integer
            minimum: 1
            maximum: 7
          description: Weekdays dispatch is allowed, 1=Monday through 7=Sunday.
        dispatch_hours_overrides:
          type: object
          nullable: true
          additionalProperties: true
          description: Per-weekday overrides of the default dispatch hours.
        max_attempts_per_lead:
          type: integer
        max_parallel_calls:
          type: integer
          nullable: true
        conversion_outcomes:
          type: array
          items:
            type: string
          nullable: true
        outcome_mapping:
          type: object
          nullable: true
          additionalProperties: true
        pause_reason:
          type: string
          nullable: true
        config:
          type: object
          additionalProperties: true
          description: >-
            Call configuration applied to every call dispatched by this
            campaign.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
          nullable: true
    Problem:
      type: object
      required:
        - status
        - title
      properties:
        type:
          type: string
          format: uri
          description: Error type URI
        title:
          type: string
          description: Error title
        status:
          type: integer
          description: HTTP status code
        detail:
          type: string
          description: Human-readable error detail
        code:
          type: string
          description: >
            Machine-readable error code for programmatic handling. Present on

            errors that carry a stable identifier (e.g. `PROMPT_SAFETY_FRAUD`,

            `job_not_found`, `too_many_ids`, `no_matches`). Distinct from the

            per-field `errors[].code` used for validation failures. Scenario-

            specific — see each endpoint's response examples for the exact
            value.
        instance:
          type: string
          format: uuid
          description: Request instance ID
        errors:
          type: array
          description: Validation errors (for 400 responses)
          items:
            type: object
            properties:
              path:
                type: string
                description: Field path (e.g., "phone_number", "metadata.from_number")
              message:
                type: string
                description: Error message
              code:
                type: string
                description: Error code (e.g., "invalid_string", "custom")
        details:
          type: string
          description: Additional error details (for provider errors)
  responses:
    Unauthorized:
      description: Unauthorized (missing or invalid API key)
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            status: 401
            title: Unauthorized
            detail: Invalid or missing API key
    Forbidden:
      description: Forbidden (missing required scope)
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            status: 403
            title: Forbidden
            detail: 'Missing required scope: calls:write'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        Use `Authorization: Bearer tc_live_xxxxx`

````