Deel: Organizations schemas
38 Deel schemas with complete fields and constraints.
← Organizations operations · All schemas
Add admins to child organizations — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The outcome of the request. |
items | array | Required within parent | One item per admin and child organization pair of the request. |
items[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
child_org_id | string | Required within parent | The public id of the child organization. Format: uuid |
email | string | Required within parent | The email of the admin, as submitted. Format: email |
status | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | 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. Known values: ADDED, ALREADY_ADMIN, FAILED |
Add admins to child organizations — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The request payload. |
admins | array | Required within parent | The people to add as admins of every submitted child organization. |
admins[] | Model | Each item | Expand Add admins to child organizations — request body — body data admins item |
child_org_ids | array | Required within parent | Public 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[] | string | Each item | Format: 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Required within parent | The email of the person. Each email may appear once per request, ignoring case. Format: email Maximum length: 255 |
first_name | string | Required within parent | The first name of the person. Used only when the email has no Deel account yet. Maximum length: 100 Minimum length: 1 |
last_name | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approved_at | string | Optional | The date the registration was approved. Present only when the status is APPROVED. Format: date |
company_domain | string | Optional | The normalised root domain stored on the registration. Absent when the status is REJECTED. |
company_name | string | Optional | The company name stored on the registration. Absent when the status is REJECTED. |
countries | array | Optional | The countries stored on the registration, or an empty array when none are stored. Absent when the status is REJECTED. |
countries[] | string | Each item | |
expected_deal_size | JSON | Optional | |
expected_deal_size (anyOf 1) | number | Alternative | The expected deal size stored on the registration. Absent when the status is REJECTED. Format: double |
expected_deal_size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
expires_at | string | Optional | The date the 90-day protection window ends. Present only when the status is APPROVED. Format: date |
message | string | Optional | A generic ineligibility message. Present only when the status is REJECTED. It is deliberately identical for every rejection reason. |
products | array | Optional | The products stored on the registration. Absent when the status is REJECTED. |
products[] | string | Each item | |
region | string | Optional | The region stored on the registration. Absent when the status is REJECTED. |
status | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The request payload. |
company_domain | string | Required within parent | The 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_name | string | Required within parent | The end client's legal company name. Maximum length: 255 Minimum length: 1 |
countries | array | Optional | Optional ISO 3166-1 alpha-2 codes for the countries the deal covers. |
countries[] | string | Each item | Maximum length: 2 Minimum length: 2 |
expected_deal_size | number | Required within parent | The expected annual contract value of the deal. Format: double Maximum: 1000000000 Minimum: 1 |
products | array | Required within parent | The Deel products the partner expects to sell. |
products[] | string | Each item | One of: EOR, IC, COR, GP, Contractor Management, US Payroll, PEO, Immigration, Deel HR, Deel IT |
region | string | Required within parent | The sales region the deal belongs to. One of: NAM, EMEA, APAC, LATAM |
Create a session token for a child organization — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The issued session token. |
expires_at | string | Required within parent | ISO 8601 timestamp when the session token expires (6 hours from issuance). Format: date-time |
token | string | Required within parent | The short-lived session token for the child organisation. |
Create child organization — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create child organization — 201 response body — data |
Referenced models: Create child organization — 201 response body — data
Create child organization — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | When the created child organization was created (ISO 8601 format) Format: date-time |
id | string | Required within parent | The unique identifier of the created child organization. |
token | string | Required within parent | The API token generated for the created child organization |
updated_at | string | Required within parent | When the created child organization was updated for the last time (ISO 8601 format) Format: date-time |
Create child organization — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The request payload. |
child_admins | array | Optional | People from the child organization to add as its admins. Each person receives an invite to the child organization. |
child_admins[] | Model | Each item | Expand Create child organization — request body — body data child admins item |
child_organization | Model | Required within parent | Expand 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_emails | array | Optional | More 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[] | string | Each item | Format: email Maximum length: 255 |
parent_organization | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A person from the child organization who becomes one of its admins. |
email | string | Required within parent | The email of the person from the child organization. Format: email Maximum length: 255 |
first_name | string | Required within parent | The first name of the person from the child organization. Maximum length: 100 |
last_name | string | Required within parent | The last name of the person from the child organization. Maximum length: 100 |
Create child organization — request body — body data child organization
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The object that contains all the information related to the child organization that will be created. |
department | string | Optional | The department's name where the manager will be added. Defaults to "Founder" when omitted. Default: Founder Maximum length: 255 |
headquarters_country | string | Optional | The 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_enabled | boolean | Optional | The flag that enables the public API for the child organization. Defaults to false when omitted. Default: false |
name | string | Required within parent | The organization's name. Maximum length: 255 |
workforce_size | integer | Optional | The workforce size of the child organization. Maximum: 1000000 Minimum: 1 |
Create child organization — request body — body data parent organization
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The object that contains the information related to the parent_organization. |
admin_email | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Optional | Organization role description |
hrisOrgStructureId | string | Optional | HRIS organization structure id |
id | JSON | Optional | |
id (anyOf 1) | number | Alternative | Organization role id Format: double |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Optional | Organization role name |
permissionSets | array | Optional | |
permissionSets[] | string | Each item | |
scope | string | Optional | Organization role scope |
Create organization custom role — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Required within parent | Organization role description |
hrisOrgStructureId | string | Optional | HRIS organization structure id |
name | string | Required within parent | Organization role name |
permissionSets | array | Required within parent | |
permissionSets[] | string | Each item | |
scope | string | Required within parent | Organization role scope |
Get Current Organization — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | |
data[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The unique identifier of the organization. Format: uuid |
name | string | Required within parent | The name of the organization. Minimum length: 1 |
Get Teams — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Get Teams — 200 response body — data item |
Referenced models: Get Teams — 200 response body — data item
Get Teams — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The unique identifier of the team within the organization. Format: uuid |
name | string | Required within parent | The name of the team. Minimum length: 1 |
Get the roles of the current organization — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
hrisOrgStructureId | JSON | Optional | |
hrisOrgStructureId (anyOf 1) | string | Alternative | The HRIS (Human Resource Information System) organization structure ID associated with the role, if applicable. |
hrisOrgStructureId (anyOf 2) | null | Alternative | The HRIS (Human Resource Information System) organization structure ID associated with the role, if applicable. |
id | JSON | Required within parent | |
id (anyOf 1) | number | Alternative | The unique identifier for the role. Format: double |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Required within parent | The name of the role. |
scope | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | |
data[] | Model | Each item | Expand Retrieve Departments — 200 response body — data item |
Referenced models: Retrieve Departments — 200 response body — data item
Retrieve Departments — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The unique identifier for the department. Format: uuid |
name | string | Required within parent | The name of the department. Minimum length: 1 |
parent | JSON | Optional | |
parent (anyOf 1) | string | Alternative | The ID of the parent department, if applicable. |
parent (anyOf 2) | null | Alternative | The ID of the parent department, if applicable. |
Retrieve terms and conditions acceptance — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The organization's terms and conditions acceptance. |
accepted_at | JSON | Required within parent | |
accepted_at (anyOf 1) | string | Alternative | Latest acceptance across the legal agreements and the terms of service; null when none. Format: date-time |
accepted_at (anyOf 2) | null | Alternative | Latest acceptance across the legal agreements and the terms of service; null when none. Format: date-time |
agreements | array | Required within parent | The legal agreements (master service agreement pages) the organization must accept, at their current version. |
agreements[] | Model | Each item | Expand Retrieve terms and conditions acceptance — 200 response body — data agreements item |
status | string | Required within parent | `ACCEPTED` once every legal agreement and the platform terms of service are accepted. Known values: ACCEPTED, PENDING |
terms_of_service | JSON | Required within parent | The platform terms of service acceptance; null when not accepted. |
terms_of_service (anyOf 1) | Model | Alternative | Expand Submit terms and conditions acceptance — 200 response body — data terms of service accepted at, version |
terms_of_service (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accepted_at | JSON | Required within parent | |
accepted_at (anyOf 1) | string | Alternative | When this version of the agreement was accepted; null until it is accepted. Format: date-time |
accepted_at (anyOf 2) | null | Alternative | When this version of the agreement was accepted; null until it is accepted. Format: date-time |
title | JSON | Required within parent | |
title (anyOf 1) | string | Alternative | Title of the legal agreement page, as published in the Deel Legal Hub. |
title (anyOf 2) | null | Alternative | Title of the legal agreement page, as published in the Deel Legal Hub. |
version | JSON | Required within parent | |
version (anyOf 1) | number | Alternative | Current version of the agreement page. Format: double |
version (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve working locations — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | JSON | Required within parent | |
id (anyOf 1) | number | Alternative | Unique identifier of this resource. Format: double |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Required within parent |
Submit terms and conditions acceptance — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The organization's terms and conditions acceptance. |
accepted_at | JSON | Required within parent | |
accepted_at (anyOf 1) | string | Alternative | Latest acceptance across the legal agreements and the terms of service; null when none. Format: date-time |
accepted_at (anyOf 2) | null | Alternative | Latest acceptance across the legal agreements and the terms of service; null when none. Format: date-time |
agreements | array | Required within parent | The legal agreements (master service agreement pages) accepted for the organization. |
agreements[] | Model | Each item | Expand Submit terms and conditions acceptance — 200 response body — data agreements item |
status | string | Required within parent | `ACCEPTED` once every legal agreement and the platform terms of service are accepted. Known values: ACCEPTED, PENDING |
terms_of_service | JSON | Required within parent | The platform terms of service acceptance; null when not accepted. |
terms_of_service (anyOf 1) | Model | Alternative | Expand Submit terms and conditions acceptance — 200 response body — data terms of service accepted at, version |
terms_of_service (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accepted_at | string | Required within parent | When this version of the agreement was accepted. Format: date-time |
title | JSON | Required within parent | |
title (anyOf 1) | string | Alternative | Title of the legal agreement page, as published in the Deel Legal Hub. |
title (anyOf 2) | null | Alternative | Title of the legal agreement page, as published in the Deel Legal Hub. |
version | JSON | Required within parent | |
version (anyOf 1) | number | Alternative | Current version of the agreement page. Format: double |
version (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Submit terms and conditions acceptance — 200 response body — data terms of service accepted at, version
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The platform terms of service acceptance; null when not accepted. |
accepted_at | string | Required within parent | When the platform terms of service were accepted. Format: date-time |
version | string | Required within parent | Version of the Deel platform terms of service. |
Update organization custom role — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Optional | Description of the role |
id | JSON | Optional | |
id (anyOf 1) | number | Alternative | ID of the role Format: double |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Optional | Name of the role |
permissionSets | array | Optional | |
permissionSets[] | string | Each item | |
scope | string | Optional | Scope of the role |
Update organization custom role — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Optional | Description of the role |
name | string | Optional | Name of the role |
permissionSets | array | Optional | |
permissionSets[] | string | Each item |