Skip to content

Deel: List of immigration cases

Deel immigration.getClientCases: arguments, response, policy and SDK examples.

← Immigration operations · Get started

Operation deel.immigration_getclientcases

Provider route: GET /immigration/client/cases. Alter supplies the connection’s credentials and routing.

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"]["getClientCases"]>[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.getClientCases(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from 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_client_cases(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryModelOptionalExpand List of immigration cases — request body — query

Referenced models: List of immigration cases — request body — query

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand List of immigration cases — 200 response body

Referenced models: List of immigration cases — 200 response body

List of immigration cases — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentList of cases in the current page.
data[]ModelEach itemExpand List of immigration cases — 200 response body — data item
has_morebooleanRequired within parentIndicates whether more results are available for pagination.
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternativeCursor value to be used for fetching the next page of results.
next_cursor (anyOf 2)nullAlternativeCursor value to be used for fetching the next page of results.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of cases matching the search criteria.
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List of immigration cases — 200 response body — data item

List of immigration cases — request body — query
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
searchstringOptionalMaximum length: 100
Minimum length: 3
case_type_idsarrayOptional
case_type_ids[]stringEach itemFormat: uuid
statusesarrayOptional
statuses[]stringEach itemOne of: OPEN, ON_HOLD, CLOSED
countriesarrayOptional
countries[]stringEach itemMaximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
cursorstringOptional
limitintegerOptionalDefault: 20
Maximum: 100
List of immigration cases — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
applicantJSONRequired within parentApplicant associated with the immigration case.
applicant (anyOf 1)ModelAlternativeExpand List of immigration cases — 200 response body — data item applicant Applicant associated with the immigration case
applicant (anyOf 2)nullAlternative
case_typeModelRequired within parentExpand List of immigration cases — 200 response body — data item case type
Type of immigration case.
closureJSONRequired within parentClosure details of the case if the case has been closed.
closure (anyOf 1)ModelAlternativeExpand List of immigration cases — 200 response body — data item closure note, reason
closure (anyOf 2)nullAlternative
created_atstringRequired within parentTimestamp indicating when the case was created.
Format: date-time
idstringRequired within parentUnique identifier of the immigration case.
Format: uuid
processModelRequired within parentExpand List of immigration cases — 200 response body — data item process
Current active process associated with the case.
statusstringRequired within parentCurrent lifecycle status of the immigration case.
Known values: OPEN, CLOSED, ON_HOLD
updated_atstringRequired within parentTimestamp indicating when the case was last updated.
Format: date-time

Referenced models: List of immigration cases — 200 response body — data item case type, List of immigration cases — 200 response body — data item applicant Applicant associated with the immigration case, List of immigration cases — 200 response body — data item closure note, reason, List of immigration cases — 200 response body — data item process

List of immigration cases — 200 response body — data item case type
FieldTypePresenceDescription and constraints
$objectRootType of immigration case.
idstringRequired within parentUnique identifier of the case type.
Format: uuid
namestringRequired within parentHuman-readable name of the case type.
Maximum length: 255
List of immigration cases — 200 response body — data item applicant Applicant associated with the immigration case
FieldTypePresenceDescription and constraints
$objectRootApplicant associated with the immigration case.
idJSONOptional
id (anyOf 1)stringAlternativeUnique identifier of the applicant.
Format: uuid
id (anyOf 2)nullAlternativeUnique identifier of the applicant.
Format: uuid
namestringRequired within parentFull name of the applicant.
Maximum length: 255
List of immigration cases — 200 response body — data item closure note, reason
FieldTypePresenceDescription and constraints
$objectRootClosure details of the case if the case has been closed.
noteJSONRequired within parent
note (anyOf 1)stringAlternativeAdditional notes explaining the case closure.
Maximum length: 400
note (anyOf 2)nullAlternativeAdditional notes explaining the case closure.
Maximum length: 400
reasonJSONRequired within parentReason why the immigration case was closed.
reason (anyOf 1)stringAlternativeReason why the immigration case was closed.
Known values: CONTRACT_CANCELLED, NATIONALITY_CHANGE, NEW_CASE_TYPE_IS_REQUIRED, ONBOARDING_RELEASED, TERMINATION_REVERSED, CONVERTED_TO_VISA_APPLICATION, OTHER
reason (anyOf 2)nullAlternative
List of immigration cases — 200 response body — data item process
FieldTypePresenceDescription and constraints
$objectRootCurrent active process associated with the case.
idstringRequired within parentUnique identifier of the current process.
Format: uuid
namestringRequired within parentHuman-readable name of the current process step.
Maximum length: 255
statusModelRequired within parentExpand List of immigration cases — 200 response body — data item process status
Current status of the process.

Referenced models: List of immigration cases — 200 response body — data item process status

List of immigration cases — 200 response body — data item process status
FieldTypePresenceDescription and constraints
$objectRootCurrent status of the process.
idJSONRequired within parent
id (anyOf 1)stringAlternativeUnique identifier of the process status.
Format: uuid
id (anyOf 2)nullAlternativeUnique identifier of the process status.
Format: uuid
nameJSONRequired within parent
name (anyOf 1)stringAlternativeHuman-readable name of the process status.
Maximum length: 255
name (anyOf 2)nullAlternativeHuman-readable name of the process status.
Maximum length: 255

SDK function policy ID: deel.immigration_getclientcases. Catalog operation: immigration_getclientcases. 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-01-01"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.