Skip to navigation
EndpointsImmigration

List immigration cases

Beta

Lists the immigration cases the token can see, newest first. Use it to track the progress of your workers’ cases or to find a case before reading its timeline or documents.

Token scopes: immigration:read, worker:read

Beta: this version requires the X-Beta: true request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-02-10.

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

OR
AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Headers

X-BetaenumRequiredDefaults to true

Opts in to the beta version of this endpoint. Must be true.

Allowed values:

Query parameters

work_typeslist of enumsOptional
Only cases of these work types.
Allowed values:
statuseslist of enumsOptional
Only cases in these statuses.
Allowed values:
countrieslist of stringsOptional

Only cases in these destination countries (ISO 3166-1 alpha-2).

searchstringOptional<=100 characters
Matches the worker name, a contract id or a case reference.
cursorstringOptional<=1024 characters

Opaque pagination cursor returned as next_cursor from a previous response. Omit to fetch the first page.

limitintegerOptional1-100Defaults to 20
Maximum number of cases to return. Capped at 100.

Response

Successful response with the cases.
datalist of objects
has_moreboolean
Whether more items are available beyond this page.
next_cursorstring or null
Cursor to pass as cursor to fetch the next page. Null when there is no next page.
total_countinteger or null

Number of matching cases, capped at 1000. Only on the first page; null when a cursor is sent.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error