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

# Get a call by id

**Required scope:** `calls.view`


## OpenAPI

````yaml /api-reference/openapi.json get /calls/{id}
openapi: 3.0.3
info:
  title: Pineyard API
  version: 1.0.0
  description: >-
    Programmatic access to agents, campaigns, calls, phone numbers, WhatsApp and
    results in your Pineyard workspace.
servers:
  - url: https://api.pineyard.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /calls/{id}:
    get:
      summary: Get a call by id
      parameters:
        - schema:
            type: string
          required: true
          name: id
          in: path
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  referenceId:
                    type: string
                    nullable: true
                  hasOpenIssue:
                    type: boolean
                  contactName:
                    type: string
                    nullable: true
                  contactFields:
                    type: object
                    nullable: true
                    additionalProperties:
                      nullable: true
                  doNotCall:
                    type: boolean
                  doNotCallAt:
                    type: string
                    nullable: true
                  dncSource:
                    type: string
                    nullable: true
                  dncReason:
                    type: string
                    nullable: true
                  agentId:
                    type: string
                    nullable: true
                  agentName:
                    type: string
                    nullable: true
                  source:
                    type: string
                  campaignId:
                    type: string
                    nullable: true
                  campaignName:
                    type: string
                    nullable: true
                  campaignSource:
                    type: string
                    nullable: true
                  apiDelivery:
                    type: object
                    nullable: true
                    properties:
                      requestId:
                        type: string
                        nullable: true
                      idempotencyKey:
                        type: string
                        nullable: true
                      receivedAt:
                        type: string
                      requestBody:
                        nullable: true
                      requestTruncated:
                        type: boolean
                    required:
                      - requestId
                      - idempotencyKey
                      - receivedAt
                      - requestTruncated
                  toNumber:
                    type: string
                  fromNumber:
                    type: string
                  status:
                    type: string
                  disposition:
                    type: string
                    nullable: true
                  answeredBy:
                    type: string
                    nullable: true
                  endCallReason:
                    type: string
                    nullable: true
                  hangupCause:
                    type: string
                    nullable: true
                  hangupSource:
                    type: string
                    nullable: true
                  billDurationSeconds:
                    type: number
                    nullable: true
                  transferredAt:
                    type: string
                    nullable: true
                  transferTarget:
                    type: string
                    nullable: true
                  durationMs:
                    type: number
                    nullable: true
                  queuedAt:
                    type: string
                  initiatedAt:
                    type: string
                    nullable: true
                  answeredAt:
                    type: string
                    nullable: true
                  endedAt:
                    type: string
                    nullable: true
                  transcript:
                    nullable: true
                  transcriptLang:
                    type: string
                    nullable: true
                  transcriptTranslation:
                    nullable: true
                  summary:
                    type: string
                    nullable: true
                  hasRecording:
                    type: boolean
                  recordingUrl:
                    type: string
                    nullable: true
                  recordingUrlExpires:
                    type: string
                    nullable: true
                  extraction:
                    nullable: true
                  errorMessage:
                    type: string
                    nullable: true
                  creditsUsed:
                    type: string
                  billingMode:
                    type: string
                    nullable: true
                    enum:
                      - PER_60S
                      - PER_15S_AFTER_60S
                  pricePerMinuteSnapshotMicroRupees:
                    type: string
                    nullable: true
                  billingIncrementSnapshotSeconds:
                    type: integer
                    nullable: true
                  billsecSeconds:
                    type: number
                    nullable: true
                  attemptNumber:
                    type: number
                    nullable: true
                  reengage:
                    type: object
                    nullable: true
                    properties:
                      churnEnabled:
                        type: boolean
                      churnDepth:
                        type: number
                      attemptCount:
                        type: number
                      churnMaxAttempts:
                        type: number
                      nextEligibleAt:
                        type: string
                        nullable: true
                      contactStatus:
                        type: string
                    required:
                      - churnEnabled
                      - churnDepth
                      - attemptCount
                      - churnMaxAttempts
                      - nextEligibleAt
                      - contactStatus
                  outcome:
                    type: string
                    nullable: true
                  dialReason:
                    type: string
                    nullable: true
                  history:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        attemptNumber:
                          type: number
                          nullable: true
                        dialReason:
                          type: string
                          nullable: true
                        outcome:
                          type: string
                          nullable: true
                        status:
                          type: string
                        durationMs:
                          type: number
                          nullable: true
                        queuedAt:
                          type: string
                        campaignId:
                          type: string
                          nullable: true
                        campaignName:
                          type: string
                          nullable: true
                        hasRecording:
                          type: boolean
                      required:
                        - id
                        - attemptNumber
                        - dialReason
                        - outcome
                        - status
                        - durationMs
                        - queuedAt
                        - campaignId
                        - campaignName
                        - hasRecording
                  hiddenAt:
                    type: string
                    nullable: true
                  hiddenRefundMicro:
                    type: string
                    nullable: true
                required:
                  - id
                  - referenceId
                  - hasOpenIssue
                  - contactName
                  - contactFields
                  - doNotCall
                  - doNotCallAt
                  - dncSource
                  - dncReason
                  - agentId
                  - agentName
                  - source
                  - campaignId
                  - campaignName
                  - campaignSource
                  - apiDelivery
                  - toNumber
                  - fromNumber
                  - status
                  - disposition
                  - answeredBy
                  - endCallReason
                  - hangupCause
                  - hangupSource
                  - billDurationSeconds
                  - transferredAt
                  - transferTarget
                  - durationMs
                  - queuedAt
                  - initiatedAt
                  - answeredAt
                  - endedAt
                  - transcriptLang
                  - summary
                  - hasRecording
                  - recordingUrl
                  - recordingUrlExpires
                  - errorMessage
                  - creditsUsed
                  - billingMode
                  - pricePerMinuteSnapshotMicroRupees
                  - billingIncrementSnapshotSeconds
                  - billsecSeconds
                  - attemptNumber
                  - reengage
                  - outcome
                  - dialReason
                  - history
                  - hiddenAt
                  - hiddenRefundMicro
        '400':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.

            - `invalid_body`: The request body (or query) failed validation.
            Details are in `issues` (or `detail`). `422` on `POST
            /v1/campaigns/{campaignId}/leads`.
        '401':
          description: >-
            - `invalid_api_key`: The API key is unknown, revoked or expired, or
            its workspace was deleted.

            - `unauthorized`: No `Authorization: Bearer` header, or an empty
            token.
        '403':
          description: >-
            - `api_key_not_scoped`: A key issued without scopes was used outside
            `/v1`.

            - `api_key_owner_inactive`: The member the key acts for was removed
            or suspended.

            - `forbidden`: The key lacks the permission named in
            `requiredPermission`, or the resource belongs to another workspace.

            - `workspace_pending_approval`: The workspace has not been approved
            yet.

            - `workspace_suspended`: The workspace is suspended.
        '404':
          description: >-
            - `not_found`: The resource does not exist in your workspace, or the
            feature is not enabled for it.
        '413':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '429':
          description: '- `rate_limited`: Too many requests.'
        '500':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '502':
          description: >-
            - `provider_error`: The calling service rejected the request
            (`upstreamStatus` 4xx) or was unavailable (5xx).
        '503':
          description: '- `database_unavailable`: The service is temporarily unavailable.'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. `pk_live_xxxxxxxxxxxxxxxxxxxxxxxx`.

````

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