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

# Search deliveries

> Top-level alias: POST /admin/api/search/deliveries.



## OpenAPI

````yaml /openapi.json post /admin/api/projects/{pid}/search/deliveries
openapi: 3.1.0
info:
  title: Hookie API
  version: 1.0.0
  summary: Capture, route and deliver webhooks.
  description: >-
    Hookie exposes three HTTP surfaces.


    **Ingest + streaming** is the public plane. A path-form endpoint URL
    authenticates by its own high-entropy slug — there is no key, token or
    cookie — and an `ik_live_…` ingest key authenticates the `/v1/*` routes.
    Whenever the URL names a dataset the payload is stored whole into it;
    project mapping rules are evaluated on exactly one shape, `POST
    /v1/ingest/{ingest_key}` with no dataset segment.


    **The customer portal API** is a separate, token-authed surface for your end
    customers, scoped to one portal and one customer.


    **The admin API** drives the console. It accepts either a browser session or
    an OAuth bearer token from a connected coding agent — the same routes, the
    same validation, the same audit trail. An agent's authority is its user's
    workspace role narrowed to the scopes granted in the console.


    This document is generated from the request handlers and adversarially
    verified against them.
  contact:
    name: Hookie
    url: https://hookie.ai
  license:
    name: Proprietary
    url: https://hookie.ai/legal/terms
servers:
  - url: https://app.hookie.ai
    description: Production
  - url: https://app.preview.hookie.ai
    description: Preview
security: []
tags:
  - name: Ingest
    description: Send events to Hookie.
  - name: Streaming
    description: Tail events in real time over SSE or WebSocket.
  - name: Portal
    description: Token-authed surface for your end customers.
  - name: Projects
    description: Projects and their settings.
  - name: Routing
    description: Rules, endpoints, datasets and records.
  - name: Delivery
    description: Destinations, deliveries and replay.
  - name: Workflows
    description: Multi-step workflows, triggers and AI agents.
  - name: Observability
    description: Search, correlation, stats and the audit log.
  - name: Workspace
    description: Members, connected agents, SSO and billing.
paths:
  /admin/api/projects/{pid}/search/deliveries:
    post:
      tags:
        - Search
      summary: Search deliveries
      description: 'Top-level alias: POST /admin/api/search/deliveries.'
      operationId: searchDeliveries
      parameters:
        - name: pid
          in: path
          required: true
          description: Project id (UUID) belonging to the caller workspace.
          schema:
            type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              description: >-
                All filters optional and ANDed. Note there is no until filter on
                this entity.
              properties:
                status:
                  type: string
                  enum:
                    - queued
                    - delivering
                    - delivered
                    - failed
                    - dead
                  description: Matched exactly; any string is accepted by the handler.
                response_code:
                  type: integer
                  description: Must be an integer.
                destination_id:
                  type: string
                min_latency_ms:
                  type: number
                  description: Matches response_ms >= value.
                since:
                  type: string
                  description: ISO timestamp; matches created_at >= since.
                limit:
                  type: integer
                  minimum: 1
                  maximum: 200
                  default: 25
                offset:
                  type: integer
                  minimum: 0
                  default: 0
      responses:
        '200':
          description: One page of deliveries, newest first.
          content:
            application/json:
              schema:
                type: object
                required:
                  - entity
                  - count
                  - total
                  - limit
                  - offset
                  - results
                properties:
                  entity:
                    type: string
                    const: deliveries
                  count:
                    type: integer
                  total:
                    type: integer
                  limit:
                    type: integer
                  offset:
                    type: integer
                  results:
                    type: array
                    items:
                      type: object
                      required:
                        - id
                        - destination_id
                        - event_id
                        - dataset
                        - status
                        - response_code
                        - response_ms
                        - attempts
                        - error
                        - created_at
                        - updated_at
                      properties:
                        id:
                          type: string
                        destination_id:
                          type: string
                        event_id:
                          type: string
                        dataset:
                          type: string
                        status:
                          type: string
                        response_code:
                          type:
                            - integer
                            - 'null'
                        response_ms:
                          type:
                            - integer
                            - 'null'
                        attempts:
                          type: integer
                        error:
                          type:
                            - string
                            - 'null'
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type:
                            - string
                            - 'null'
                          format: date-time
        '400':
          description: >-
            response_code must be an integer, or min_latency_ms must be a
            number.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: >-
            Not signed in, or the agent bearer token is invalid, unknown or
            revoked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            A cookie-authenticated request missing the X-Requested-With: fetch
            header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Project not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - session: []
        - bearerAuth: []
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Human-readable reason.
        retry_after:
          type: integer
          description: Seconds to wait. Present on 429.
        upgrade_url:
          type: string
          format: uri
          description: Present only on a monthly-quota 429.
  securitySchemes:
    session:
      type: apiKey
      in: cookie
      name: hookie_session
      description: >-
        The console's sealed session cookie, set by WorkOS AuthKit. Mutating
        requests also require the `X-Requested-With` CSRF header.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        An OAuth 2.1 access token from a connected agent, audienced at the
        `/mcp` resource URI. The agent acts as its user, with that user's role
        narrowed to the granted `hookie:*` scopes. No CSRF header is required —
        a bearer token is not ambient credentials.

````