Deel: Get case timeline
Deel immigration.getCaseTimeline: arguments, response, policy and SDK examples.
← Immigration operations · Get started
Operation deel.immigration_getcasetimeline_v2026_10_14
Provider route: GET /immigration/cases/{case_id}/timeline. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["immigration"]["getCaseTimeline"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.immigration.getCaseTimeline(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.immigration.get_case_timeline(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.case_id | string | Required within parent | Format: uuid |
headers | object | Required within parent | Additional keys: not allowed |
headers.X-Beta | string | Required within parent | Default: true One of: true |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get case timeline — 200 response body |
Referenced models: Get case timeline — 200 response body
Schemas
Section titled “Schemas”Get case timeline — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get case timeline — 200 response body — data |
Referenced models: Get case timeline — 200 response body — data
Get case timeline — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
ongoing_actions | JSON | Required within parent | |
ongoing_actions (anyOf 1) | integer | Alternative | Number of actions currently waiting on the client or the employee. |
ongoing_actions (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
processes | array | Required within parent | Processes of the case in order. |
processes[] | Model | Each item | Expand Get case timeline — 200 response body — data processes item |
Referenced models: Get case timeline — 200 response body — data processes item
Get case timeline — 200 response body — data processes item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The unique identifier of the process. |
name | string | Required within parent | Display name of the process. |
state | string | Required within parent | Whether the process is not started, active or completed. Known values: ACTIVE, COMPLETED, NOT_STARTED |
steps | array | Required within parent | Steps of the process in order. |
steps[] | Model | Each item | Expand Get case timeline — 200 response body — data processes item steps item |
Referenced models: Get case timeline — 200 response body — data processes item steps item
Get case timeline — 200 response body — data processes item steps item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
actions | array | Required within parent | Actions attached to the step, earliest due first. |
actions[] | Model | Each item | Expand Get case timeline — 200 response body — data processes item steps item actions item |
activated_at | JSON | Required within parent | |
activated_at (anyOf 1) | string | Alternative | UTC timestamp when the step became active. Null while the step has not started. Format: date-time |
activated_at (anyOf 2) | null | Alternative | UTC timestamp when the step became active. Null while the step has not started. Format: date-time |
completed_at | JSON | Required within parent | |
completed_at (anyOf 1) | string | Alternative | UTC timestamp when the step was completed. Null while the step is open. Format: date-time |
completed_at (anyOf 2) | null | Alternative | UTC timestamp when the step was completed. Null while the step is open. Format: date-time |
id | string | Required within parent | The unique identifier of the step. |
name | string | Required within parent | Display name of the step. |
state | string | Required within parent | Whether the step is not started, active or completed. Known values: ACTIVE, COMPLETED, NOT_STARTED |
Referenced models: Get case timeline — 200 response body — data processes item steps item actions item
Get case timeline — 200 response body — data processes item steps item actions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
completed_at | JSON | Required within parent | |
completed_at (anyOf 1) | string | Alternative | UTC timestamp when the action was completed. Null while the action is open. Format: date-time |
completed_at (anyOf 2) | null | Alternative | UTC timestamp when the action was completed. Null while the action is open. Format: date-time |
description | string | Required within parent | What the assigned party has to do. |
due_date | JSON | Required within parent | |
due_date (anyOf 1) | string | Alternative | UTC timestamp by which the action is expected to be completed. Format: date-time |
due_date (anyOf 2) | null | Alternative | UTC timestamp by which the action is expected to be completed. Format: date-time |
id | JSON | Required within parent | |
id (anyOf 1) | string | Alternative | The unique identifier of the action. |
id (anyOf 2) | null | Alternative | The unique identifier of the action. |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | Short title of the action. |
name (anyOf 2) | null | Alternative | Short title of the action. |
status | JSON | Required within parent | Progress of the action. |
status (anyOf 1) | string | Alternative | Progress of the action. Known values: TODO, ONGOING, COMPLETED, ARCHIVED |
status (anyOf 2) | null | Alternative | |
type | Model | Required within parent | Expand Get case timeline — 200 response body — data processes item steps item actions item type The kind of action expected from the assigned party. |
user_type | string | Required within parent | The party expected to complete the action: the client organization or the employee. Known values: CLIENT, APPLICANT |
Referenced models: Get case timeline — 200 response body — data processes item steps item actions item type
Get case timeline — 200 response body — data processes item steps item actions item type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | The kind of action expected from the assigned party. Known values: FILL_FORM, REVIEW_REOPENED_FORM, DOWNLOAD_BUSINESS_LETTER, AGENT_REVIEW_BUSINESS_LETTER, CLIENT_REVIEW_BUSINESS_LETTER, GENERATE_BUSINESS_VISA_LETTER, AGENT_REVIEW, CLIENT_REVIEW_DOCUMENT, AGENT_STATUS_UPDATE, QUOTE_CREATE, QUOTE_DRAFT, QUOTE_APPROVAL, QUOTE_PAYMENT_REQUEST, QUOTE_REJECTED, QUOTE_APPROVAL_EMPLOYEE, UPLOAD_DOCUMENT, UPLOAD_ADDITIONAL_DOCUMENT, FILL_ADDITIONAL_FORM, AGENT_ADD_SALESFORCE_URL, AGENT_STATUS_UPDATE_SLA_BREACH, FILL_REQUIRED_ROLES, REVIEW_SUBMITTED_FORM, REVIEW_FORM, REVIEW_UPLOADED_DOCUMENT, REVIEW_ZENDESK_COMMENT, SIGNATURE_PENDING, PETITION_AI_REVIEW, AMENDMENT_DETAIL_REVIEW, REVIEW_GOOGLE_DOCUMENT, PAY_INVOICE_ACTION, ESTIMATED_COMPLETION, REVIEW_VENDOR_ASSIGNMENT, UPDATE_VISA_TYPE, CUSTOM_TASK, AGENT_ADD_USCIS_RECEIPT_NUMBER, AGENT_ADD_SHIPPING_NUMBER, IDENTITY_VERIFICATION, IDENTITY_VERIFICATION_VERIFF, IDENTITY_VERIFICATION_REVIEW, SEND_VISA_APPLICATION_QUOTE, REVIEW_VISA_APPLICATION_QUOTE, COMPLIANCE_VERIFF, RTW_VERIFICATION_DOCUMENT_REVIEW, UPLOAD_REQUIRED_DOCUMENT, REVIEW_REQUIRED_DOCUMENT, ADD_BUSINESS_VISA_DETAILS, ADD_UK_SHARECODE, RUN_AI_AGENT, REVIEW_VISA_AUTOMATION_PAYLOAD, PRE_HIRE_DOCUMENT_REVIEW, ACKNOWLEDGE_CONTENT, PETITION_AUTONOMOUS_BUILD, PAY_MILESTONE_INVOICE, AGENT_ADD_RFE_DEADLINE |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.immigration_getcasetimeline_v2026_10_14. Catalog operation: immigration_getcasetimeline_v2026_10_14. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["immigration:read"]
Pinned headers: {"X-Version": "2026-10-14"}