Immigration

List of immigration cases

Use this endpoint to track the progress of your organization's immigration cases and identify ones that need attention, such as those currently on hold.

Token scopes: immigration:read

get/immigration/client/cases

Request

  • Base URL: https://api.letsdeel.com/rest
  • URL: https://api.letsdeel.com/rest/immigration/client/cases
  • Auth: HTTP bearer

Query parameters

searchstring

Search by applicant name or code

case_type_idsstring[]

Filter by case type IDs

statusesImmigrationClientCasesGetParametersStatusesSchemaItems[]

Filter by case status

countriesstring[]

Filter by country. Uses ISO 3166-1 alpha-2 codes (https://www.iban.com/country-codes).

cursorstring

Pagination cursor for fetching next set of results

limitinteger

Max number of results to return

Response

Successful operation.

has_moreboolean required

Indicates whether more results are available for pagination.

next_cursorstring nullable

Cursor value to be used for fetching the next page of results.

total_countinteger required

Total number of cases matching the search criteria.

Changes

No recorded changes to this operation across all 1 revision of this API.