Deel: Lookups schemas
13 Deel schemas with complete fields and constraints.
← Lookups operations · All schemas
Job titles list — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | |
data[] | Model | Each item | Expand Job titles list — 200 response body — data item |
page | Model | Optional | Expand Job titles list — 200 response body — page |
Referenced models: Job titles list — 200 response body — page, Job titles list — 200 response body — data item
Job titles list — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | identifier of the job title Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Required within parent | Job title. |
Job titles list — 200 response body — page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cursor | string | Required within parent | Use for pagination to get next set of records after the given cursor. |
Retrieve Country List — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | |
data[] | Model | Each item | Expand Retrieve Country List — 200 response body — data item |
Referenced models: Retrieve Country List — 200 response body — data item
Retrieve Country List — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
code | string | Required within parent | The ISO 3166-1 alpha-2 country code. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
default_currency | string | Required within parent | Indicates the default currency 3-letter ISO code Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
eor_support | boolean | Required within parent | Indicates whether Deel provides Employer of Record (EoR) support in this country. |
name | string | Required within parent | The official name of the country. Minimum length: 1 |
state_type | JSON | Required within parent | |
state_type (anyOf 1) | string | Alternative | The designation for sub-territories within the country, such as 'state', 'province', 'prefecture', or 'region'. If none, this field will be null. |
state_type (anyOf 2) | null | Alternative | The designation for sub-territories within the country, such as 'state', 'province', 'prefecture', or 'region'. If none, this field will be null. |
states | array | Required within parent | List of sub-territories within the country. These may be called states, provinces, prefectures, regions, or may not exist. |
states[] | Model | Each item | Expand Retrieve Country List — 200 response body — data item states item |
visa_support | boolean | Required within parent | Indicates whether Deel provides visa support for employees being hired in this country. |
Referenced models: Retrieve Country List — 200 response body — data item states item
Retrieve Country List — 200 response body — data item states item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
code | string | Required within parent | The code representing the sub-territory (e.g., state or region). Minimum length: 1 |
name | string | Required within parent | The name of the sub-territory (e.g., state or region). Minimum length: 1 |
Retrieve Seniority Levels — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | List of predefined seniority levels supported by the Deel platform. |
data[] | Model | Each item | Expand Retrieve Seniority Levels — 200 response body — data item |
Referenced models: Retrieve Seniority Levels — 200 response body — data item
Retrieve Seniority Levels — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | A unique identifier for the seniority level. Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
level | JSON | Optional | |
level (anyOf 1) | JSON | Alternative | |
level (anyOf 1) (anyOf 1) | number | Alternative | The hierarchical level of seniority, where higher numbers indicate greater seniority. Format: double |
level (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
level (anyOf 2) | null | Alternative | The hierarchical level of seniority, where higher numbers indicate greater seniority. Format: double |
name | string | Required within parent | The name of the seniority level, e.g., 'Mid (Individual Contributor Level 2)'. Minimum length: 1 |
Retrieve Supported Currency List — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | List of currencies supported by Deel. |
data[] | Model | Each item | Expand Retrieve Supported Currency List — 200 response body — data item |
Referenced models: Retrieve Supported Currency List — 200 response body — data item
Retrieve Supported Currency List — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
code | string | Required within parent | The ISO 4217 three-letter currency code. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the currency. This may be null if a name is not available. |
name (anyOf 2) | null | Alternative | The name of the currency. This may be null if a name is not available. |
Retrieve Time-Off Types — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | List of predefined time-off types supported by the Deel platform. |
data[] | string | Each item | Predefined time-off types. Possible values include 'VACATION', 'SICK_LEAVE', 'UNPAID_LEAVE' and 'OTHER'. Known values: VACATION, SICK_LEAVE, OTHER, UNPAID_LEAVE |
Retrieve lookup information for currencies, countries, entity types, etc — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | |
data[] | Model | Each item | Expand Retrieve lookup information for currencies, countries, entity types, etc — 200 response body — data item |
Referenced models: Retrieve lookup information for currencies, countries, entity types, etc — 200 response body — data item
Retrieve lookup information for currencies, countries, entity types, etc — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
label | string | Optional | The label for the lookup item (e.g., country name, entity type). |
value | string | Optional | The value associated with the lookup item (e.g., ISO code, type identifier). |