Retrieve HRX documents | Deel

Retrieves a list of HRX documents that have been shared with an employee for a specific EOR contract. These documents are generated and managed by HRX (Human Resources Experience) and include various employment-related documents such as employment agreements, onboarding materials, tax documents, visa support letters, and other official documentation required throughout the employment lifecycle. Token scopes: worker:read, contracts: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/

Path parameters

contract_idstringRequired

The unique identifier of the employee contract.

Query parameters

cursorstringOptional

Cursor for pagination. Use the cursor from the previous response to get the next page of results.

limitintegerOptional1-100Defaults to 20

Number of items to return per page. Maximum is 100, default is 20.

Response

HRX documents successfully retrieved for EOR contract

datalist of objects

List of employee documents

has_moreboolean

Indicates if there are more pages available

next_cursorstring or null

Cursor to use for the next page. Null if there are no more pages.

total_countinteger

Total number of documents available across all pages

1	import requests
2
3	url = "https://api.letsdeel.com/rest/v2/eor/contracts/5B74FnLM/hrx-documents"
4
5	querystring = {"cursor":"eyJpZCI6ImNiMjhlOWE3LTQzY2YtNGYyNC1iZTZmLWQ3Mjk5MWNhY2UyZSJ9","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": "cb28e9a7-43cf-4f24-be6f-d72991cace2e",
5	"name": "Employment Agreement Contract",
6	"category": "Onboarding & Registration",
7	"created_at": "2025-09-16T11:54:06.763Z",
8	"updated_at": "2025-09-16T11:54:50.168Z",
9	"category_id": "eda410c0-6148-4c72-96fa-8d3b6895bf5d",
10	"category_type": "EMPLOYMENT_AGREEMENT",
11	"category_description": "Core legal contract establishing the terms and conditions of employment between the worker and the EOR"
12	},
13	{
14	"id": "eda410c0-6148-4c72-96fa-8d3b6895bf5d",
15	"name": "Visa Application Letter",
16	"category": "Tax & Fiscal",
17	"created_at": "2025-09-16T12:26:47.769Z",
18	"updated_at": "2025-09-16T12:30:01.320Z",
19	"category_id": "cb28e9a7-43cf-4f24-be6f-d72991cace2e",
20	"category_type": "EMPLOYMENT_AGREEMENT",
21	"category_description": "Employer-issued letters and certificates supporting visa applications, renewals, and travel abroad"
22	}
23	],
24	"has_more": true,
25	"next_cursor": "eyJpZCI6ImVkYTQxMGMwLTYxNDgtNGM3Mi05NmZhLThkM2I2ODk1YmY1ZCJ9",
26	"total_count": 42
27	}

Authentication

Authentication

Path parameters

Query parameters

Response

Errors

Authentication