List of immigration cases | Deel

Retrieves a paginated list of immigration cases with filters for applicant name, case type, status, and country. Returns case details including type, status, process, timestamps, and optional closure information. Token scopes: immigration:read

Authentication

AuthorizationBearer

Authentication

Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE'

## Authentication Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. ``` curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` ### Generating Access Tokens 1. Navigate to **Apps & Perks > Developer Center**. 2. Click on the “Generate New Token” button. 3. In the popup, click “Generate Token” button to generate a new token. Your newly generated token is visible on the screen. 4. Make sure to copy and save your token once is generated. You won't be able to see it again!

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.

next_cursorstring or null

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

total_countinteger

Total number of cases matching the search criteria.

1	import requests
2
3	url = "https://api.letsdeel.com/rest/v2/immigration/client/cases"
4
5	querystring = {"search":"john","case_type_ids":"[\"e9b4ce94-2e3e-4d41-9faf-1ad2389cac1d\"]","statuses":"[\"OPEN\",\"ON_HOLD\",\"CLOSED\"]","countries":"[\"AE\",\"SA\"]","cursor":"next-page-token-123","limit":"20"}
6
7	headers = {"Authorization": "Bearer <token>"}
8
9	response = requests.get(url, headers=headers, params=querystring)
10
11	print(response.json())

1	{
2	"data": [
3	{
4	"id": "d7348f5b-b0a6-4c84-ae07-2e5ccdd60134",
5	"status": "OPEN",
6	"closure": {
7	"note": "Employee contract was terminated.",
8	"reason": "CONTRACT_CANCELLED"
9	},
10	"process": {
11	"id": "c8895566-11aa-22bb-33cc-44dd55ee66ff",
12	"name": "Initial Review",
13	"status": {
14	"id": "f1234567-abcd-ef01-2345-6789abcd0123",
15	"name": "IN_PROGRESS"
16	}
17	},
18	"applicant": {
19	"name": "John Doe",
20	"id": "b1234567-89ab-cdef-0123-456789abcdef"
21	},
22	"case_type": {
23	"id": "a1234567-89ab-cdef-0123-456789abcdef",
24	"name": "Work Permit"
25	},
26	"created_at": "2024-01-12T08:30:00Z",
27	"updated_at": "2024-01-13T10:45:00Z"
28	}
29	],
30	"has_more": true,
31	"next_cursor": "eyJpZCI6IjEyMzQ1NiJ9",
32	"total_count": 100
33	}

Authentication

Authentication

Query parameters

Response

Errors

Authentication