> ## 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. # Correlate a submission or record across the pipeline > Top-level alias: GET /admin/api/search/correlate/{id}. Readable by any role. ## OpenAPI ````yaml /openapi.json get /admin/api/projects/{pid}/search/correlate/{id} 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/correlate/{id}: get: tags: - Search summary: Correlate a submission or record across the pipeline description: >- Top-level alias: GET /admin/api/search/correlate/{id}. Readable by any role. operationId: correlateById parameters: - name: pid in: path required: true description: Project id (UUID) belonging to the caller workspace. schema: type: string - name: id in: path required: true description: >- A record id or a submission id. A record id is resolved to its submission first. schema: type: string responses: '200': description: >- The whole chain: the submission (or null when only records matched), every record produced from it, and the deliveries and AI runs keyed off those record ids. content: application/json: schema: type: object required: - correlation_id - submission - records - deliveries - ai_runs properties: correlation_id: type: string description: The resolved submission id. submission: type: - object - 'null' properties: id: type: string received_at: type: string format: date-time source: type: - string - 'null' forward_status: type: - string - 'null' payload: type: string description: Truncated to 2000 characters. records: type: array items: type: object required: - id - dataset - source - received_at properties: id: type: string dataset: type: string source: type: - string - 'null' received_at: type: string format: date-time deliveries: type: array items: type: object required: - id - destination_id - event_id - status - response_code - response_ms - created_at properties: id: type: string destination_id: type: string event_id: type: string status: type: string response_code: type: - integer - 'null' response_ms: type: - integer - 'null' created_at: type: string format: date-time ai_runs: type: array items: type: object required: - id - trigger_id - event_id - status - model - created_at - finished_at properties: id: type: string trigger_id: type: - string - 'null' event_id: type: - string - 'null' status: type: string model: type: - string - 'null' created_at: type: string format: date-time finished_at: type: - string - 'null' format: date-time '400': description: correlation id required (the id path segment is missing). 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: >- Email domain not allowed for the workspace, or an agent token granted no Hookie scope. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: >- Nothing found for that id - neither a submission nor any record in this project matched. content: application/json: schema: $ref: '#/components/schemas/Error' '405': description: Method not allowed - correlate is GET only. 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. ````