Retrieve a list of ATS locations | Deel

Use this endpoint to list ATS locations for jobs Token scopes: ats: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

cursorstringOptional

The cursor for pagination

limitintegerOptional1-100Defaults to 20

Maximum number of records returned in one response

Response

Successful response with locations data

datalist of objects

has_moreboolean

Indicates if there are more locations available

next_cursorstring or null

Cursor for pagination to get the next set of results

total_countinteger

Total number of locations available

1	import requests
2
3	url = "https://api.letsdeel.com/rest/v2/ats/locations"
4
5	querystring = {"cursor":"cursorValue","limit":"50"}
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": "550e8400-e29b-41d4-a716-446655440000",
5	"name": "United States",
6	"created_at": "2023-01-01T00:00:00Z",
7	"updated_at": "2023-01-01T00:00:00Z",
8	"city": "New York",
9	"is_remote": false,
10	"country_code": "US",
11	"location_group": {
12	"id": "550e8400-e29b-41d4-a716-446655440000",
13	"name": "Remote"
14	},
15	"province_or_region_text": "New York"
16	}
17	],
18	"has_more": true,
19	"next_cursor": "cursor123",
20	"total_count": 100
21	}

Authentication

Authentication

Query parameters

Response

Errors

Authentication