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

# List line webhook deliveries

> Returns `{ "deliveries": [ … ] }`: the webhook's latest deliveries, **newest first**, with their status and outcome — **never their payload** (a `phone_line.code_received` carries the activation code; read one delivery in full with `GET …/deliveries/{deliveryId}`). A webhook of another workspace answers **404 `WEBHOOK_NOT_FOUND`**, never an empty list.

Permissions: with an OAuth / MCP token, the user must be an **Owner or Admin** (`phone_lines:webhooks`) — `403 PERMISSION_DENIED` otherwise.

Every `/v1/phone-lines` endpoint takes a **tenant-scoped** key only: phone-line webhooks belong to the workspace, not to a WhatsApp number, so a number-scoped key (or a per-number OAuth grant) gets `403 NUMBER_SCOPE_NOT_ALLOWED` before any role is looked at. A `403 PERMISSION_DENIED` / `WORKSPACE_MEMBERSHIP_REQUIRED` is sent with `Cache-Control: no-store`.

These are the **phone-line webhooks** — a registry separate from `/v1/webhooks`: they receive only `phone_line.*` events, and a number webhook never receives one.

**Requires a tenant-scoped key.**



## OpenAPI

````yaml openapi.json GET /v1/phone-lines/webhooks/{id}/deliveries
openapi: 3.1.0
info:
  title: Pilot Status API
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    Public REST API for Pilot Status. Authenticate with the `x-api-key: ps_...`
    header (or `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/phone-lines/webhooks/{id}/deliveries:
    get:
      tags:
        - Phone Lines
      summary: List a webhook's deliveries
      description: >-
        Returns `{ "deliveries": [ … ] }`: the webhook's latest deliveries,
        **newest first**, with their status and outcome — **never their
        payload** (a `phone_line.code_received` carries the activation code;
        read one delivery in full with `GET …/deliveries/{deliveryId}`). A
        webhook of another workspace answers **404 `WEBHOOK_NOT_FOUND`**, never
        an empty list.


        Permissions: with an OAuth / MCP token, the user must be an **Owner or
        Admin** (`phone_lines:webhooks`) — `403 PERMISSION_DENIED` otherwise.


        Every `/v1/phone-lines` endpoint takes a **tenant-scoped** key only:
        phone-line webhooks belong to the workspace, not to a WhatsApp number,
        so a number-scoped key (or a per-number OAuth grant) gets `403
        NUMBER_SCOPE_NOT_ALLOWED` before any role is looked at. A `403
        PERMISSION_DENIED` / `WORKSPACE_MEMBERSHIP_REQUIRED` is sent with
        `Cache-Control: no-store`.


        These are the **phone-line webhooks** — a registry separate from
        `/v1/webhooks`: they receive only `phone_line.*` events, and a number
        webhook never receives one.


        **Requires a tenant-scoped key.**
      operationId: get_phone_lines_webhooks_id_deliveries
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          example: cmh1w8b2k0001wh8example3d
          description: >-
            The webhook's `id` (from `GET /v1/phone-lines/webhooks` or the
            create response).
        - name: limit
          in: query
          required: false
          description: >-
            From 1 to 200 (default 50). Any other value (0, 201, a decimal,
            text, empty) → `400 INVALID_LIMIT`.
          schema:
            type: string
            description: (integer (1–200))
          example: '50'
      responses:
        '200':
          description: The latest deliveries
          content:
            application/json:
              schema:
                type: object
                properties:
                  deliveries:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: >-
                            The delivery id — the same `id` (and
                            `Idempotency-Key` header) your endpoint received.
                          example: cmh1w9c4m0002dl8example5f
                        event:
                          type: string
                          example: phone_line.code_received
                        status:
                          type: string
                          enum:
                            - PENDING
                            - DELIVERED
                            - FAILED
                          description: >-
                            `PENDING` (still being attempted), `DELIVERED` or
                            `FAILED` (attempts exhausted, or the webhook was
                            paused).
                          example: DELIVERED
                        attempts:
                          type: integer
                          description: Attempts so far (at most 6).
                          example: 1
                        responseStatus:
                          type:
                            - integer
                            - 'null'
                          description: >-
                            HTTP status of the last attempt, `null` when it got
                            no HTTP answer.
                          example: 200
                        lastError:
                          type:
                            - string
                            - 'null'
                          description: Why the last attempt failed, `null` when it did not.
                          example: null
                        createdAt:
                          type: string
                          format: date-time
                          example: '2026-10-27T14:11:51.000Z'
                        deliveredAt:
                          type:
                            - string
                            - 'null'
                          format: date-time
                          example: '2026-10-27T14:11:52.000Z'
              example:
                deliveries:
                  - id: cmh1w9c4m0002dl8example5f
                    event: phone_line.code_received
                    status: DELIVERED
                    attempts: 1
                    responseStatus: 200
                    lastError: null
                    createdAt: '2026-10-27T14:11:51.000Z'
                    deliveredAt: '2026-10-27T14:11:52.000Z'
        '400':
          description: '`limit` is not an integer from 1 to 200'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: >-
                  limit must be an integer between 1 and 200. | limit deve ser
                  um inteiro entre 1 e 200.
                code: INVALID_LIMIT
        '401':
          description: >-
            Missing or invalid credential (`x-api-key`, `x-api-key-id` or
            `Authorization: Bearer`). The body carries only `error`, no `code`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              examples:
                missing:
                  summary: No credential
                  value:
                    error: >-
                      Missing x-api-key, x-api-key-id or Authorization Bearer
                      token
                invalid:
                  summary: Invalid API key
                  value:
                    error: Invalid API key
        '403':
          description: >-
            Number-scoped key (`NUMBER_SCOPE_NOT_ALLOWED`), OAuth/MCP token of a
            user who is not Owner or Admin (`PERMISSION_DENIED`) or no longer an
            active member (`WORKSPACE_MEMBERSHIP_REQUIRED`), or archived
            workspace (`WORKSPACE_ARCHIVED`). `TENANT_REQUIRED`: credential not
            bound to any workspace
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              examples:
                numberScope:
                  summary: Number-scoped key
                  value:
                    error: This endpoint requires a tenant-scoped API key
                    code: NUMBER_SCOPE_NOT_ALLOWED
                permissionDenied:
                  summary: OAuth/MCP user who is not Owner or Admin
                  value:
                    error: >-
                      Your workspace role does not allow this action
                      (phone_lines:webhooks).
                    code: PERMISSION_DENIED
                notMember:
                  summary: OAuth/MCP user no longer a member
                  value:
                    error: >-
                      The user behind this token is not an active member of this
                      workspace.
                    code: WORKSPACE_MEMBERSHIP_REQUIRED
                archived:
                  summary: Workspace archived
                  value:
                    error: >-
                      This workspace has been archived and its API is closed. |
                      Este workspace foi arquivado e sua API está encerrada.
                    code: WORKSPACE_ARCHIVED
                tenantRequired:
                  summary: Credential not bound to a workspace
                  value:
                    error: This credential is not bound to a workspace.
                    code: TENANT_REQUIRED
        '404':
          description: >-
            No such webhook in your workspace (`WEBHOOK_NOT_FOUND`) — a webhook
            of another workspace reads the same
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Webhook not found. | Webhook não encontrado.
                code: WEBHOOK_NOT_FOUND
        '500':
          description: Unexpected failure (`INTERNAL_ERROR`).
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unexpected error. | Erro inesperado.
                code: INTERNAL_ERROR
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Your ps_ API key
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: API key id (alternative to x-api-key)

````

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