---
title: "Retrieve the Status of an Intake Agent Run Job"
method: GET
path: "/intake-agent/run/{asyncJobId}"
tags: ["Agents"]
---

# Retrieve the Status of an Intake Agent Run Job

`GET /intake-agent/run/{asyncJobId}`

## Request

- Base URL: `https://ironcladapp.com/public/api/v1`
- URL: `https://ironcladapp.com/public/api/v1/intake-agent/run/{asyncJobId}`
- Auth: API key in header `Authorization` and OAuth 2
  - Authorization code: `https://ironcladapp.com/oauth/authorize`
  - Client credentials
  - Token URL: `https://ironcladapp.com/oauth/token` scopes: `public.agents.runIntakeAgent`

Check the status of an Intake Agent run you started while using the [Run Intake Agent](https://developer.ironcladapp.com/reference/run-intake-agent-async) route. 

**OAuth Scope required:** `public.agents.runIntakeAgent`

## Path parameters

- `asyncJobId` string, required

## Response `200`

The status of the Intake Agent run.

- union: The current status of the Intake Agent run job.
  - object: Response for a successfully asynchronously run Intake Agent.
    - `status` 'success', required
    - `requestPayload` IntakeAgentRunRequestPayload, required
      - `template` string, required: The identifier of the workflow template
    - `extractedFields` IntakeAgentField[], required: Extracted form field values with reasoning and source citations.
      - `id` string, required: The form field ID as configured in the workflow template
      - `reasoning` string, required: The agent's explanation for the extracted value
      - `citations` IntakeAgentCitation[], required: Source citations supporting the extracted value
        - `sourceType` 'document' | 'web', required: Whether the citation comes from an uploaded document or captured web content
        - `exactMatchingTextPageNumber` number, required: The page number where the exact matching text was found. When `sourceType` is `web`, this is the page number where the URL that the value was extracted from was found.
        - `exactMatchingText` string, required: The exact text that was used to extract the field's value. When `sourceType` is `web`, this is the URL that the value was extracted from.
        - `fileName` string, required: The name of the file where the exact matching text was found. When `sourceType` is `web`, this is the name of the file where the URL that the value was extracted from was found.
        - `sourceContent` string: Populated only when `sourceType` is `web`. Applicable content of the web page used as the source of the extraction.
      - `value` object, required: The extracted field value. The shape depends on the field type (text, date, select, number, address, etc.)
        - `type` string, required: Field type: text, paragraph, email, select, number, boolean, date, address, duration, monetaryAmount, entity, linkedRecord, etc.
  - object
    - `status` 'failed', required
    - `requestPayload` IntakeAgentRunRequestPayload, required
      - `template` string, required: The identifier of the workflow template
    - `error` object, required: An error object indicating why the Intake Agent run failed.
      - `message` string, required: A message indicating why the Intake Agent run failed.
  - object
    - `status` 'in_progress', required
    - `requestPayload` IntakeAgentRunRequestPayload, required
      - `template` string, required: The identifier of the workflow template

## Other responses

- `401`: 401
- `403`: 403
- `404`: 404
- `500`: 500

## Changes

- **2026-11-03** `435da5a4396e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/ironcladapp/apis/ironclad-public-api/changes/intake-agent/run/:asyncJobId/get.md)

---

[API](https://skmtc.dev/ironcladapp/apis/ironclad-public-api.md) - [All operations](https://skmtc.dev/ironcladapp/apis/ironclad-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ironcladapp/apis/ironclad-public-api/revisions/435da5a4396e?raw)