Retrieve a list of ATS locations | Deel

List locations: Returns a paginated list of all locations associated with an organization in ATS. Use this to retrieve available work locations when creating job postings or filtering candidates by location. Scope: ats:read Token scopes: ats: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.

1 curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
2   -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

## 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 curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)

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

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

1	curl -G https://api.letsdeel.com/rest/v2/ats/locations \
2	-H "Authorization: Bearer <token>" \
3	-d cursor=cursorValue \
4	-d limit=50

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	}

1	curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
2	-H 'Authorization: Bearer YOUR-TOKEN-HERE'