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

# List an endpoint's deliveries

> Newest first. Deliveries are kept for 30 days.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/webhook-endpoints/{endpoint_id}/deliveries
openapi: 3.1.0
info:
  title: Ciarem API
  version: v1
  description: >
    The Ciarem public API. Authenticate every request with an org-bound API key

    (created in Settings → API keys; Growth or Scale plan, or free trial) sent
    as a bearer token:

    `Authorization: Bearer oak_…`.


    Compatibility: this is an early, fast-moving API. Most changes are

    additive (new endpoints, new optional params, new response fields, new

    enum/string values) — clients must tolerate unknown fields and unknown

    string values. Every contract change is listed in the changelog at

    help.ciarem.ai.
servers:
  - url: https://api.ciarem.ai
security:
  - apiKey: []
tags:
  - name: Account
    description: The organization behind the API key.
  - name: Contacts
    description: People in the CRM — create, read, update, delete.
  - name: CRM
    description: 'The shape of the CRM: custom properties and funnel stages.'
  - name: Conversations
    description: Read the message history of a conversation.
  - name: WhatsApp numbers
    description: The connected numbers a send can go out from.
  - name: WhatsApp templates
    description: Message templates, and what each one needs filled before it can be sent.
  - name: Broadcasts
    description: Send a template, and follow what happened to every recipient.
  - name: Webhooks
    description: Have Ciarem POST events to your server as they happen, instead of polling.
paths:
  /v1/webhook-endpoints/{endpoint_id}/deliveries:
    get:
      tags:
        - Webhooks
      summary: List an endpoint's deliveries
      description: Newest first. Deliveries are kept for 30 days.
      operationId: >-
        list_webhook_deliveries_v1_webhook_endpoints__endpoint_id__deliveries_get
      parameters:
        - name: endpoint_id
          in: path
          required: true
          schema:
            type: string
            title: Endpoint Id
        - name: status
          in: query
          required: false
          schema:
            anyOf:
              - enum:
                  - pending
                  - succeeded
                  - failed
                  - exhausted
                type: string
              - type: 'null'
            title: Status
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Cursor
        - name: limit
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                maximum: 100
                minimum: 1
              - type: 'null'
            title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicWebhookDeliveryList'
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
        '401':
          description: >-
            No usable credential: `missing_bearer_token` (no `Authorization:
            Bearer`) or `invalid_api_key` (unknown or revoked key).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicError'
        '403':
          description: >-
            The credential is real but not allowed here: `api_key_required` (a
            session token rather than an `oak_` key), `plan_upgrade_required`
            (the plan doesn't include API access — upgrade to Growth or Scale),
            `trial_expired` (the free trial ended without a card — subscribe to
            keep the key working), or `subscription_required` (the subscription
            is canceled or suspended).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicError'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: >-
            Over the organization's request budget (`rate_limited`); the budget
            depends on the plan. `Retry-After` says how many seconds to wait.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicError'
          headers:
            Retry-After:
              description: Seconds until the window resets.
              schema:
                type: integer
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
        '503':
          description: >-
            The API is at capacity (`server_busy`). The request was not run and
            does not count against the budget; retry after `Retry-After`
            seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicError'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
components:
  schemas:
    PublicWebhookDeliveryList:
      properties:
        items:
          items:
            $ref: '#/components/schemas/PublicWebhookDelivery'
          type: array
          title: Items
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
      type: object
      required:
        - items
        - next_cursor
      title: PublicWebhookDeliveryList
    PublicError:
      description: An error whose `detail` is a stable, machine-readable code.
      properties:
        detail:
          title: Detail
          type: string
      required:
        - detail
      title: PublicError
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PublicWebhookDelivery:
      properties:
        id:
          type: string
          title: Id
        endpoint_id:
          type: string
          title: Endpoint Id
        event_id:
          type: string
          title: Event Id
        event_type:
          type: string
          title: Event Type
        status:
          type: string
          enum:
            - pending
            - succeeded
            - failed
            - exhausted
          title: Status
        attempt_count:
          type: integer
          title: Attempt Count
        next_attempt_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Next Attempt At
        last_attempt_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Attempt At
        response_status:
          anyOf:
            - type: integer
            - type: 'null'
          title: Response Status
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
        created_at:
          type: string
          format: date-time
          title: Created At
        payload:
          additionalProperties: true
          type: object
          title: Payload
      type: object
      required:
        - id
        - endpoint_id
        - event_id
        - event_type
        - status
        - attempt_count
        - next_attempt_at
        - last_attempt_at
        - response_status
        - error
        - created_at
        - payload
      title: PublicWebhookDelivery
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  headers:
    X-RateLimit-Limit:
      description: Requests allowed per window, shared across the org's keys.
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests left in the current window.
      schema:
        type: integer
    X-RateLimit-Reset:
      description: When the window resets, as a Unix timestamp in seconds.
      schema:
        type: integer
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'An org API key: `Authorization: Bearer oak_…`.'

````

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