Skip to content

Deel: ATS locations schemas

3 Deel schemas with complete fields and constraints.

← ATS locations operations · All schemas

Retrieve a list of ATS locations — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPage of locations.
data[]ModelEach itemExpand Retrieve a list of ATS locations — 200 response body — data item
has_morebooleanRequired within parentIndicates if there are more locations available
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor for pagination to get the next set of results
next_cursor (anyOf 2)nullAlternativeCursor for pagination to get the next set of results
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of locations available
Minimum: 0
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve a list of ATS locations — 200 response body — data item

Retrieve a list of ATS locations — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
archived_atJSONOptional
archived_at (anyOf 1)stringAlternativeTimestamp when the location was archived; null while the location is active and selectable
Format: date-time
archived_at (anyOf 2)nullAlternativeTimestamp when the location was archived; null while the location is active and selectable
Format: date-time
cityJSONOptional
city (anyOf 1)stringAlternativeCity name
city (anyOf 2)nullAlternativeCity name
country_codeJSONOptional
country_code (anyOf 1)stringAlternativeISO country code
country_code (anyOf 2)nullAlternativeISO country code
created_atstringRequired within parentTimestamp when the location was created
Format: date-time
idstringRequired within parentUnique identifier for the location
Format: uuid
is_remotebooleanOptionalIndicates if this is a remote location
location_groupJSONOptionalLocation group information
location_group (anyOf 1)ModelAlternativeExpand Retrieve a list of ATS locations — 200 response body — data item location group Location group information
location_group (anyOf 2)nullAlternative
namestringRequired within parentName of the location/country
province_or_region_textJSONOptional
province_or_region_text (anyOf 1)stringAlternativeProvince or region text
province_or_region_text (anyOf 2)nullAlternativeProvince or region text
updated_atstringRequired within parentTimestamp when the location was last updated
Format: date-time

Referenced models: Retrieve a list of ATS locations — 200 response body — data item location group Location group information

Retrieve a list of ATS locations — 200 response body — data item location group Location group information

FieldTypePresenceDescription and constraints
$objectRootLocation group information
idstringRequired within parentUnique identifier for the location group
Format: uuid
namestringRequired within parentName of the location group

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.