List of immigration cases | Deel

curl -G https://api.letsdeel.com/rest/immigration/client/cases \
     -H "Authorization: Bearer <token>" \
     -d case_type_ids=e9b4ce94-2e3e-4d41-9faf-1ad2389cac1d \
     -d countries=AE \
     -d countries=SA \
     -d cursor=next-page-token-123 \
     -d limit=20 \
     -d search=john \
     -d statuses=OPEN \
     -d statuses=ON_HOLD \
     -d statuses=CLOSED

{
  "data": [
    {
      "id": "d7348f5b-b0a6-4c84-ae07-2e5ccdd60134",
      "status": "OPEN",
      "closure": {
        "note": "Employee contract was terminated.",
        "reason": "CONTRACT_CANCELLED"
      },
      "process": {
        "id": "c8895566-11aa-22bb-33cc-44dd55ee66ff",
        "name": "Initial Review",
        "status": {
          "id": "f1234567-abcd-ef01-2345-6789abcd0123",
          "name": "IN_PROGRESS"
        }
      },
      "applicant": {
        "name": "John Doe",
        "id": "b1234567-89ab-cdef-0123-456789abcdef"
      },
      "case_type": {
        "id": "a1234567-89ab-cdef-0123-456789abcdef",
        "name": "Work Permit"
      },
      "created_at": "2024-01-12T08:30:00Z",
      "updated_at": "2024-01-13T10:45:00Z"
    }
  ],
  "has_more": true,
  "total_count": 100,
  "next_cursor": "eyJpZCI6IjEyMzQ1NiJ9"
}

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

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

AuthorizationBearer

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

Query parameters

searchstringOptional3-100 characters

Search by applicant name or code

case_type_idslist of stringsOptional

Filter by case type IDs

statuseslist of enumsOptional

Filter by case status

Allowed values:

countrieslist of stringsOptional

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

cursorstringOptional

Pagination cursor for fetching next set of results

limitintegerOptional<=100Defaults to 20

Max number of results to return

Response

Successful operation.

datalist of objects

List of cases in the current page.

has_moreboolean

Indicates whether more results are available for pagination.

total_countinteger

Total number of cases matching the search criteria.

next_cursorstring or nullOptional

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

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error