Retrieve a list of ATS locations | Deel

Returns a paginated list of all work locations associated with the organization, suitable for use when constructing job postings or filtering by location. 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. ```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

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

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

The cursor for pagination

Maximum number of records returned in one response

Successful response with locations data

Indicates if there are more locations available

Cursor for pagination to get the next set of results

Total number of locations available

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

$	curl -G https://api.letsdeel.com/rest/v2/ats/locations \
>	-H "Authorization: Bearer <token>" \
>	-d cursor=cursorValue \
>	-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	}

$	curl -G https://api.letsdeel.com/rest/v2/ats/locations \
>	-H "Authorization: Bearer <token>" \
>	-d cursor=cursorValue \
>	-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'