List of legal entities | Deel

Retrieve a list of legal entities in your account. Token scopes: organizations:read, accounting: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

limitintegerOptional1-100Defaults to 100

The number of results to return per page.

sort_orderenumOptionalDefaults to ASC

Sorting order of the results.

Allowed values:

cursorstringOptional

Cursor for pagination.

include_archivedbooleanOptionalDefaults to true

Whether to include archived legal entities in the results.

legal_entity_idstringOptional

Filter by specific legal entity ID.

global_payrollbooleanOptional

Filter by global payroll flag.

typestringOptional

Filter by entity type.

countrystringOptional

Filter by country.

include_payroll_settingsbooleanOptional

Whether to include payroll settings in the response.

Response

Successful operation.

datalist of objects or null

pageobject or null

1	import requests
2
3	url = "https://api.letsdeel.com/rest/v2/legal-entities"
4
5	querystring = {"limit":"100","sort_order":"ASC","cursor":"cusorpage123","include_archived":"false","legal_entity_id":"23378","global_payroll":"false","type":"company","country":"US","include_payroll_settings":"true"}
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": "b61f6b35-7670-4515-b667-066f02b7b8a0",
5	"name": "Deel US",
6	"phone": "+137867888",
7	"vat_id": "P051709055R",
8	"address": {
9	"zip": "12345",
10	"city": "San Francisco",
11	"state": "Texas",
12	"street": "123 Main St",
13	"country": "US"
14	},
15	"country": "US",
16	"created_at": "2024-01-01T12:00:00Z",
17	"sic_number": "9072",
18	"updated_at": "2024-01-02T12:00:00Z",
19	"archived_at": "2024-01-15T09:30:00Z",
20	"entity_type": "company",
21	"industry_name": "Marketing Agency",
22	"entity_subtype": "company",
23	"registrationNumber": "GSUGO3B5"
24	}
25	],
26	"page": {
27	"cursor": "cursor123"
28	}
29	}

Authentication

Authentication

Query parameters

Response

Errors

Authentication