Skip to content

Deel: Lookups schemas

13 Deel schemas with complete fields and constraints.

← Lookups operations · All schemas

Job titles list — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptional
data[]ModelEach itemExpand Job titles list — 200 response body — data item
pageModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
idJSONRequired within parent
id (anyOf 1)integerAlternativeidentifier of the job title
Format: int64
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringRequired within parentJob title.

Job titles list — 200 response body — page

FieldTypePresenceDescription and constraints
$objectRoot
cursorstringRequired within parentUse for pagination to get next set of records after the given cursor.

Retrieve Country List — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptional
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
codestringRequired within parentThe ISO 3166-1 alpha-2 country code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
default_currencystringRequired within parentIndicates the default currency 3-letter ISO code
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
eor_supportbooleanRequired within parentIndicates whether Deel provides Employer of Record (EoR) support in this country.
namestringRequired within parentThe official name of the country.
Minimum length: 1
state_typeJSONRequired within parent
state_type (anyOf 1)stringAlternativeThe 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)nullAlternativeThe designation for sub-territories within the country, such as 'state', 'province', 'prefecture', or 'region'. If none, this field will be null.
statesarrayRequired within parentList of sub-territories within the country. These may be called states, provinces, prefectures, regions, or may not exist.
states[]ModelEach itemExpand Retrieve Country List — 200 response body — data item states item
visa_supportbooleanRequired within parentIndicates 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

FieldTypePresenceDescription and constraints
$objectRoot
codestringRequired within parentThe code representing the sub-territory (e.g., state or region).
Minimum length: 1
namestringRequired within parentThe name of the sub-territory (e.g., state or region).
Minimum length: 1

Retrieve Seniority Levels — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptionalList of predefined seniority levels supported by the Deel platform.
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
idJSONRequired within parent
id (anyOf 1)integerAlternativeA unique identifier for the seniority level.
Format: int64
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
levelJSONOptional
level (anyOf 1)JSONAlternative
level (anyOf 1) (anyOf 1)numberAlternativeThe hierarchical level of seniority, where higher numbers indicate greater seniority.
Format: double
level (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
level (anyOf 2)nullAlternativeThe hierarchical level of seniority, where higher numbers indicate greater seniority.
Format: double
namestringRequired within parentThe name of the seniority level, e.g., 'Mid (Individual Contributor Level 2)'.
Minimum length: 1

Retrieve Supported Currency List — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptionalList of currencies supported by Deel.
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
codestringRequired within parentThe ISO 4217 three-letter currency code.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
nameJSONOptional
name (anyOf 1)stringAlternativeThe name of the currency. This may be null if a name is not available.
name (anyOf 2)nullAlternativeThe name of the currency. This may be null if a name is not available.

Retrieve Time-Off Types — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptionalList of predefined time-off types supported by the Deel platform.
data[]stringEach itemPredefined 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

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptional
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
labelstringOptionalThe label for the lookup item (e.g., country name, entity type).
valuestringOptionalThe value associated with the lookup item (e.g., ISO code, type identifier).

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.