> ## 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.

# Activity grouped by lead entry — one row per journey, not one per call

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


## OpenAPI

````yaml /api-reference/openapi.json get /calls/leads
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/leads:
    get:
      summary: Activity grouped by lead entry — one row per journey, not one per call
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    key:
                      type: string
                    contactId:
                      type: string
                      nullable: true
                    toNumber:
                      type: string
                    contactName:
                      type: string
                      nullable: true
                    company:
                      type: string
                      nullable: true
                    agentName:
                      type: string
                      nullable: true
                    campaignId:
                      type: string
                      nullable: true
                    campaignName:
                      type: string
                      nullable: true
                    externalRef:
                      type: string
                      nullable: true
                    apiDeliveryRequestId:
                      type: string
                      nullable: true
                    source:
                      type: string
                      nullable: true
                    doNotCall:
                      type: boolean
                    attempts:
                      type: number
                    lastCallId:
                      type: string
                    hasOpenIssue:
                      type: boolean
                    lastOutcome:
                      type: string
                      nullable: true
                    lastStatus:
                      type: string
                    lastDurationMs:
                      type: number
                      nullable: true
                    lastQueuedAt:
                      type: string
                    lastInterestLevel:
                      type: string
                      nullable: true
                    nextEligibleAt:
                      type: string
                      nullable: true
                    scheduledCallbackAt:
                      type: string
                      nullable: true
                    pendingReason:
                      type: string
                      nullable: true
                    isPending:
                      type: boolean
                    nextActionState:
                      type: string
                      nullable: true
                      enum:
                        - SCHEDULED
                        - WAITING_FOR_WINDOW
                        - READY
                        - CAMPAIGN_PAUSED
                    whatsappState:
                      type: string
                      nullable: true
                      enum:
                        - NEEDS_REPLY
                        - REPLIED
                        - READ
                        - DELIVERED
                        - SENT
                        - FAILED
                        - RETRYING
                    whatsappLastMessageAt:
                      type: string
                      nullable: true
                    disposition:
                      type: string
                      nullable: true
                  required:
                    - key
                    - contactId
                    - toNumber
                    - contactName
                    - company
                    - agentName
                    - campaignId
                    - campaignName
                    - externalRef
                    - apiDeliveryRequestId
                    - source
                    - doNotCall
                    - attempts
                    - lastCallId
                    - hasOpenIssue
                    - lastOutcome
                    - lastStatus
                    - lastDurationMs
                    - lastQueuedAt
                    - lastInterestLevel
                    - nextEligibleAt
                    - scheduledCallbackAt
                    - pendingReason
                    - isPending
                    - nextActionState
                    - whatsappState
                    - whatsappLastMessageAt
                    - disposition
        '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.
        '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.