atsLocations

Retrieve a list of ATS locations

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, worker:read

Deprecated: a newer version of this endpoint is available. This version is scheduled for removal on 2027-09-01.

Beta version available: version 2026-09-01 of this endpoint is in beta. Send X-Beta: true to call it.

get/ats/locations

Request

  • Base URL: https://api.letsdeel.com/rest
  • URL: https://api.letsdeel.com/rest/ats/locations
  • Auth: HTTP bearer

Query parameters

cursorstring

The cursor for pagination

limitinteger

Maximum number of records returned in one response

include_archivedstring

If true, archived locations are included in the response; they are excluded by default

Response

Successful response with locations data.

has_moreboolean required

Indicates if there are more locations available

next_cursorstring nullable required

Cursor for pagination to get the next set of results

total_countinteger required

Total number of locations available

Changes

No recorded changes to this operation across all 1 revision of this API.