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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Page of locations. |
data[] | Model | Each item | Expand Retrieve a list of ATS locations — 200 response body — data item |
has_more | boolean | Required within parent | Indicates if there are more locations available |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor for pagination to get the next set of results |
next_cursor (anyOf 2) | null | Alternative | Cursor for pagination to get the next set of results |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of locations available Minimum: 0 |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
archived_at | JSON | Optional | |
archived_at (anyOf 1) | string | Alternative | Timestamp when the location was archived; null while the location is active and selectable Format: date-time |
archived_at (anyOf 2) | null | Alternative | Timestamp when the location was archived; null while the location is active and selectable Format: date-time |
city | JSON | Optional | |
city (anyOf 1) | string | Alternative | City name |
city (anyOf 2) | null | Alternative | City name |
country_code | JSON | Optional | |
country_code (anyOf 1) | string | Alternative | ISO country code |
country_code (anyOf 2) | null | Alternative | ISO country code |
created_at | string | Required within parent | Timestamp when the location was created Format: date-time |
id | string | Required within parent | Unique identifier for the location Format: uuid |
is_remote | boolean | Optional | Indicates if this is a remote location |
location_group | JSON | Optional | Location group information |
location_group (anyOf 1) | Model | Alternative | Expand Retrieve a list of ATS locations — 200 response body — data item location group Location group information |
location_group (anyOf 2) | null | Alternative | |
name | string | Required within parent | Name of the location/country |
province_or_region_text | JSON | Optional | |
province_or_region_text (anyOf 1) | string | Alternative | Province or region text |
province_or_region_text (anyOf 2) | null | Alternative | Province or region text |
updated_at | string | Required within parent | Timestamp 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Location group information |
id | string | Required within parent | Unique identifier for the location group Format: uuid |
name | string | Required within parent | Name of the location group |