Skip to content

Deel: Organizations schemas

38 Deel schemas with complete fields and constraints.

← Organizations operations · All schemas

Add admins to child organizations — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Add admins to child organizations — 200 response body — data
The outcome of the request.

Referenced models: Add admins to child organizations — 200 response body — data

Add admins to child organizations — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRootThe outcome of the request.
itemsarrayRequired within parentOne item per admin and child organization pair of the request.
items[]ModelEach itemExpand Add admins to child organizations — 200 response body — data items item

Referenced models: Add admins to child organizations — 200 response body — data items item

Add admins to child organizations — 200 response body — data items item

FieldTypePresenceDescription and constraints
$objectRoot
child_org_idstringRequired within parentThe public id of the child organization.
Format: uuid
emailstringRequired within parentThe email of the admin, as submitted.
Format: email
statusModelRequired within parentExpand Add admins to child organizations — 200 response body — data items item status
The outcome for the pair. ADDED means the person is now an admin of the child organization: a person who was not a member is added with the admin role and receives the invitation email, and a member with another role is made an admin. ALREADY_ADMIN means the person already was, and nothing changed or was sent. FAILED means the pair could not be processed; the other pairs are unaffected and the same request can be retried.

Referenced models: Add admins to child organizations — 200 response body — data items item status

Add admins to child organizations — 200 response body — data items item status

FieldTypePresenceDescription and constraints
$stringRootThe outcome for the pair. ADDED means the person is now an admin of the child organization: a person who was not a member is added with the admin role and receives the invitation email, and a member with another role is made an admin. ALREADY_ADMIN means the person already was, and nothing changed or was sent. FAILED means the pair could not be processed; the other pairs are unaffected and the same request can be retried.
Known values: ADDED, ALREADY_ADMIN, FAILED

Add admins to child organizations — request body — body data

FieldTypePresenceDescription and constraints
$objectRootThe request payload.
adminsarrayRequired within parentThe people to add as admins of every submitted child organization.
admins[]ModelEach itemExpand Add admins to child organizations — request body — body data admins item
child_org_idsarrayRequired within parentPublic ids of the target child organizations, as returned in the id field of the create child organization response. Every id must be a direct child organization of the authenticated organization. The number of admins multiplied by the number of child organizations must not exceed 100.
child_org_ids[]stringEach itemFormat: uuid

Referenced models: Add admins to child organizations — request body — body data admins item

Add admins to child organizations — request body — body data admins item

FieldTypePresenceDescription and constraints
$objectRoot
emailstringRequired within parentThe email of the person. Each email may appear once per request, ignoring case.
Format: email
Maximum length: 255
first_namestringRequired within parentThe first name of the person. Used only when the email has no Deel account yet.
Maximum length: 100
Minimum length: 1
last_namestringRequired within parentThe last name of the person. Used only when the email has no Deel account yet.
Maximum length: 100
Minimum length: 1

Create a deal registration — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create a deal registration — 200 response body — data

Referenced models: Create a deal registration — 200 response body — data

Create a deal registration — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
approved_atstringOptionalThe date the registration was approved. Present only when the status is APPROVED.
Format: date
company_domainstringOptionalThe normalised root domain stored on the registration. Absent when the status is REJECTED.
company_namestringOptionalThe company name stored on the registration. Absent when the status is REJECTED.
countriesarrayOptionalThe countries stored on the registration, or an empty array when none are stored. Absent when the status is REJECTED.
countries[]stringEach item
expected_deal_sizeJSONOptional
expected_deal_size (anyOf 1)numberAlternativeThe expected deal size stored on the registration. Absent when the status is REJECTED.
Format: double
expected_deal_size (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
expires_atstringOptionalThe date the 90-day protection window ends. Present only when the status is APPROVED.
Format: date
messagestringOptionalA generic ineligibility message. Present only when the status is REJECTED. It is deliberately identical for every rejection reason.
productsarrayOptionalThe products stored on the registration. Absent when the status is REJECTED.
products[]stringEach item
regionstringOptionalThe region stored on the registration. Absent when the status is REJECTED.
statusstringRequired within parentThe eligibility outcome. APPROVED means the protection window is now active. REJECTED means the deal is not eligible.
Known values: APPROVED, REJECTED

Create a deal registration — request body — body data

FieldTypePresenceDescription and constraints
$objectRootThe request payload.
company_domainstringRequired within parentThe end client's company domain. A scheme, a "www." prefix and a path are accepted and stripped before matching.
Maximum length: 255
Minimum length: 4
company_namestringRequired within parentThe end client's legal company name.
Maximum length: 255
Minimum length: 1
countriesarrayOptionalOptional ISO 3166-1 alpha-2 codes for the countries the deal covers.
countries[]stringEach itemMaximum length: 2
Minimum length: 2
expected_deal_sizenumberRequired within parentThe expected annual contract value of the deal.
Format: double
Maximum: 1000000000
Minimum: 1
productsarrayRequired within parentThe Deel products the partner expects to sell.
products[]stringEach itemOne of: EOR, IC, COR, GP, Contractor Management, US Payroll, PEO, Immigration, Deel HR, Deel IT
regionstringRequired within parentThe sales region the deal belongs to.
One of: NAM, EMEA, APAC, LATAM

Create a session token for a child organization — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create a session token for a child organization — 201 response body — data
The issued session token.

Referenced models: Create a session token for a child organization — 201 response body — data

Create a session token for a child organization — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRootThe issued session token.
expires_atstringRequired within parentISO 8601 timestamp when the session token expires (6 hours from issuance).
Format: date-time
tokenstringRequired within parentThe short-lived session token for the child organisation.

Create child organization — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create child organization — 201 response body — data

Referenced models: Create child organization — 201 response body — data

Create child organization — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentWhen the created child organization was created (ISO 8601 format)
Format: date-time
idstringRequired within parentThe unique identifier of the created child organization.
tokenstringRequired within parentThe API token generated for the created child organization
updated_atstringRequired within parentWhen the created child organization was updated for the last time (ISO 8601 format)
Format: date-time

Create child organization — request body — body data

FieldTypePresenceDescription and constraints
$objectRootThe request payload.
child_adminsarrayOptionalPeople from the child organization to add as its admins. Each person receives an invite to the child organization.
child_admins[]ModelEach itemExpand Create child organization — request body — body data child admins item
child_organizationModelRequired within parentExpand Create child organization — request body — body data child organization
The object that contains all the information related to the child organization that will be created.
parent_admin_emailsarrayOptionalMore admins of the parent organization to add as admins of the child organization, as the Partner Portal create form does. Every email must belong to an existing admin of the parent organization, otherwise creation fails and no child organization is created. Each admin receives an invite to the child organization.
parent_admin_emails[]stringEach itemFormat: email
Maximum length: 255
parent_organizationModelRequired within parentExpand Create child organization — request body — body data parent organization
The object that contains the information related to the parent_organization.

Referenced models: Create child organization — request body — body data child admins item, Create child organization — request body — body data child organization, Create child organization — request body — body data parent organization

Create child organization — request body — body data child admins item

FieldTypePresenceDescription and constraints
$objectRootA person from the child organization who becomes one of its admins.
emailstringRequired within parentThe email of the person from the child organization.
Format: email
Maximum length: 255
first_namestringRequired within parentThe first name of the person from the child organization.
Maximum length: 100
last_namestringRequired within parentThe last name of the person from the child organization.
Maximum length: 100

Create child organization — request body — body data child organization

FieldTypePresenceDescription and constraints
$objectRootThe object that contains all the information related to the child organization that will be created.
departmentstringOptionalThe department's name where the manager will be added. Defaults to "Founder" when omitted.
Default: Founder
Maximum length: 255
headquarters_countrystringOptionalThe organization's headquarters country as an ISO 3166-1 alpha-2 code. Validated against Deel's country whitelist; unknown codes are rejected.
Maximum length: 2
Minimum length: 2
is_api_enabledbooleanOptionalThe flag that enables the public API for the child organization. Defaults to false when omitted.
Default: false
namestringRequired within parentThe organization's name.
Maximum length: 255
workforce_sizeintegerOptionalThe workforce size of the child organization.
Maximum: 1000000
Minimum: 1

Create child organization — request body — body data parent organization

FieldTypePresenceDescription and constraints
$objectRootThe object that contains the information related to the parent_organization.
admin_emailstringRequired within parentThe email of one of the managers of the parent organization. It must belong to an existing admin/manager of the parent organization, otherwise creation fails. This manager is the user that creates the child organization.
Format: email

Create organization custom role — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringOptionalOrganization role description
hrisOrgStructureIdstringOptionalHRIS organization structure id
idJSONOptional
id (anyOf 1)numberAlternativeOrganization role id
Format: double
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringOptionalOrganization role name
permissionSetsarrayOptional
permissionSets[]stringEach item
scopestringOptionalOrganization role scope

Create organization custom role — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringRequired within parentOrganization role description
hrisOrgStructureIdstringOptionalHRIS organization structure id
namestringRequired within parentOrganization role name
permissionSetsarrayRequired within parent
permissionSets[]stringEach item
scopestringRequired within parentOrganization role scope

Get Current Organization — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptional
data[]ModelEach itemExpand Get Current Organization — 200 response body — data item

Referenced models: Get Current Organization — 200 response body — data item

Get Current Organization — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentThe unique identifier of the organization.
Format: uuid
namestringRequired within parentThe name of the organization.
Minimum length: 1

Get Teams — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Get Teams — 200 response body — data item

Referenced models: Get Teams — 200 response body — data item

Get Teams — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentThe unique identifier of the team within the organization.
Format: uuid
namestringRequired within parentThe name of the team.
Minimum length: 1

Get the roles of the current organization — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Get the roles of the current organization — 200 response body — data item

Referenced models: Get the roles of the current organization — 200 response body — data item

Get the roles of the current organization — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
hrisOrgStructureIdJSONOptional
hrisOrgStructureId (anyOf 1)stringAlternativeThe HRIS (Human Resource Information System) organization structure ID associated with the role, if applicable.
hrisOrgStructureId (anyOf 2)nullAlternativeThe HRIS (Human Resource Information System) organization structure ID associated with the role, if applicable.
idJSONRequired within parent
id (anyOf 1)numberAlternativeThe unique identifier for the role.
Format: double
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringRequired within parentThe name of the role.
scopestringRequired within parentThe scope of the role, which can define the level of access. For example, 'ORGANIZATION' represents a global role within the organization.

Retrieve Departments — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptional
data[]ModelEach itemExpand Retrieve Departments — 200 response body — data item

Referenced models: Retrieve Departments — 200 response body — data item

Retrieve Departments — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentThe unique identifier for the department.
Format: uuid
namestringRequired within parentThe name of the department.
Minimum length: 1
parentJSONOptional
parent (anyOf 1)stringAlternativeThe ID of the parent department, if applicable.
parent (anyOf 2)nullAlternativeThe ID of the parent department, if applicable.

Retrieve terms and conditions acceptance — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve terms and conditions acceptance — 200 response body — data
The organization's terms and conditions acceptance.

Referenced models: Retrieve terms and conditions acceptance — 200 response body — data

Retrieve terms and conditions acceptance — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRootThe organization's terms and conditions acceptance.
accepted_atJSONRequired within parent
accepted_at (anyOf 1)stringAlternativeLatest acceptance across the legal agreements and the terms of service; null when none.
Format: date-time
accepted_at (anyOf 2)nullAlternativeLatest acceptance across the legal agreements and the terms of service; null when none.
Format: date-time
agreementsarrayRequired within parentThe legal agreements (master service agreement pages) the organization must accept, at their current version.
agreements[]ModelEach itemExpand Retrieve terms and conditions acceptance — 200 response body — data agreements item
statusstringRequired within parent`ACCEPTED` once every legal agreement and the platform terms of service are accepted.
Known values: ACCEPTED, PENDING
terms_of_serviceJSONRequired within parentThe platform terms of service acceptance; null when not accepted.
terms_of_service (anyOf 1)ModelAlternativeExpand Submit terms and conditions acceptance — 200 response body — data terms of service accepted at, version
terms_of_service (anyOf 2)nullAlternative

Referenced models: Submit terms and conditions acceptance — 200 response body — data terms of service accepted at, version, Retrieve terms and conditions acceptance — 200 response body — data agreements item

Retrieve terms and conditions acceptance — 200 response body — data agreements item

FieldTypePresenceDescription and constraints
$objectRoot
accepted_atJSONRequired within parent
accepted_at (anyOf 1)stringAlternativeWhen this version of the agreement was accepted; null until it is accepted.
Format: date-time
accepted_at (anyOf 2)nullAlternativeWhen this version of the agreement was accepted; null until it is accepted.
Format: date-time
titleJSONRequired within parent
title (anyOf 1)stringAlternativeTitle of the legal agreement page, as published in the Deel Legal Hub.
title (anyOf 2)nullAlternativeTitle of the legal agreement page, as published in the Deel Legal Hub.
versionJSONRequired within parent
version (anyOf 1)numberAlternativeCurrent version of the agreement page.
Format: double
version (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve working locations — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Retrieve working locations — 200 response body — data item

Referenced models: Retrieve working locations — 200 response body — data item

Retrieve working locations — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
idJSONRequired within parent
id (anyOf 1)numberAlternativeUnique identifier of this resource.
Format: double
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringRequired within parent

Submit terms and conditions acceptance — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Submit terms and conditions acceptance — 200 response body — data
The organization's terms and conditions acceptance.

Referenced models: Submit terms and conditions acceptance — 200 response body — data

Submit terms and conditions acceptance — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRootThe organization's terms and conditions acceptance.
accepted_atJSONRequired within parent
accepted_at (anyOf 1)stringAlternativeLatest acceptance across the legal agreements and the terms of service; null when none.
Format: date-time
accepted_at (anyOf 2)nullAlternativeLatest acceptance across the legal agreements and the terms of service; null when none.
Format: date-time
agreementsarrayRequired within parentThe legal agreements (master service agreement pages) accepted for the organization.
agreements[]ModelEach itemExpand Submit terms and conditions acceptance — 200 response body — data agreements item
statusstringRequired within parent`ACCEPTED` once every legal agreement and the platform terms of service are accepted.
Known values: ACCEPTED, PENDING
terms_of_serviceJSONRequired within parentThe platform terms of service acceptance; null when not accepted.
terms_of_service (anyOf 1)ModelAlternativeExpand Submit terms and conditions acceptance — 200 response body — data terms of service accepted at, version
terms_of_service (anyOf 2)nullAlternative

Referenced models: Submit terms and conditions acceptance — 200 response body — data terms of service accepted at, version, Submit terms and conditions acceptance — 200 response body — data agreements item

Submit terms and conditions acceptance — 200 response body — data agreements item

FieldTypePresenceDescription and constraints
$objectRoot
accepted_atstringRequired within parentWhen this version of the agreement was accepted.
Format: date-time
titleJSONRequired within parent
title (anyOf 1)stringAlternativeTitle of the legal agreement page, as published in the Deel Legal Hub.
title (anyOf 2)nullAlternativeTitle of the legal agreement page, as published in the Deel Legal Hub.
versionJSONRequired within parent
version (anyOf 1)numberAlternativeCurrent version of the agreement page.
Format: double
version (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Submit terms and conditions acceptance — 200 response body — data terms of service accepted at, version

FieldTypePresenceDescription and constraints
$objectRootThe platform terms of service acceptance; null when not accepted.
accepted_atstringRequired within parentWhen the platform terms of service were accepted.
Format: date-time
versionstringRequired within parentVersion of the Deel platform terms of service.

Update organization custom role — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringOptionalDescription of the role
idJSONOptional
id (anyOf 1)numberAlternativeID of the role
Format: double
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringOptionalName of the role
permissionSetsarrayOptional
permissionSets[]stringEach item
scopestringOptionalScope of the role

Update organization custom role — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringOptionalDescription of the role
namestringOptionalName of the role
permissionSetsarrayOptional
permissionSets[]stringEach item

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.