Deel: Onboarding schemas
56 Deel schemas with complete fields and constraints.
← Onboarding operations · All schemas
Get onboarding details by employee HRIS profile ID — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Get onboarding details by employee HRIS profile ID — 200 response body — data |
Referenced models: Get onboarding details by employee HRIS profile ID — 200 response body — data
Get onboarding details by employee HRIS profile ID — 200 response body — data
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data actions item, Get onboarding details by onboarding tracker ID — 200 response body — data app experience, Get onboarding details by onboarding tracker ID — 200 response body — data / banner / severity: ERROR, WARNING, INFO, Get onboarding details by onboarding tracker ID — 200 response body — data banners item, Get onboarding details by onboarding tracker ID — 200 response body — data checklist, Get onboarding details by onboarding tracker ID — 200 response body — data contracts item, Get onboarding details by onboarding tracker ID — 200 response body — data summary item, Get onboarding details by employee HRIS profile ID — 200 response body — data contract, Get onboarding details by onboarding tracker ID — 200 response body — data hris profile, Get onboarding details by onboarding tracker ID — 200 response body — data profile Employee profile information, Get onboarding details by onboarding tracker ID — 200 response body — data progress, Get onboarding details by onboarding tracker ID — 200 response body — data stepper item
Get onboarding details by employee HRIS profile ID — 200 response body — data contract
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about the contract |
client_signed_at | JSON | Optional | |
client_signed_at (anyOf 1) | string | Alternative | Timestamp when the client signed the contract Format: date-time |
client_signed_at (anyOf 2) | null | Alternative | Timestamp when the client signed the contract Format: date-time |
completion_date | JSON | Optional | |
completion_date (anyOf 1) | string | Alternative | The completion date of the contract, if applicable Format: date-time |
completion_date (anyOf 2) | null | Alternative | The completion date of the contract, if applicable Format: date-time |
contractor_signed_at | JSON | Optional | |
contractor_signed_at (anyOf 1) | string | Alternative | Timestamp when the contractor signed the contract Format: date-time |
contractor_signed_at (anyOf 2) | null | Alternative | Timestamp when the contractor signed the contract Format: date-time |
created_at | string | Optional | Contract creation timestamp Format: date-time |
employee_agreement | Model | Optional | Expand Get onboarding details by onboarding tracker ID — 200 response body — data contract employee agreement Information about the Employment Agreement |
first_early_invoice | JSON | Optional | Only applicable for EOR contracts. First early invoice (EOR funding statement) for the contract, if any |
first_early_invoice (anyOf 1) | Model | Alternative | Expand Get onboarding details by employee HRIS profile ID — 200 response body — data contract first early invoice amount, currency, description, due date, id, paid at, status |
first_early_invoice (anyOf 2) | null | Alternative | |
first_sign | string | Optional | The first sign (either 'client' or 'contractor') |
id | string | Optional | Unique contract ID |
invited_contractor_email | JSON | Optional | |
invited_contractor_email (anyOf 1) | string | Alternative | Email of the invited contractor Format: email |
invited_contractor_email (anyOf 2) | null | Alternative | Email of the invited contractor Format: email |
is_pwac | boolean | Optional | Whether the worker is a person without a contract |
name | string | Optional | Contract name |
oid | string | Optional | Contract OID |
status | string | Optional | Contract status (e.g., in_progress) |
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data contract employee agreement, Get onboarding details by employee HRIS profile ID — 200 response body — data contract first early invoice amount, currency, description, due date, id, paid at, status
Get onboarding details by employee HRIS profile ID — 200 response body — data contract first early invoice amount, currency, description, due date, id, paid at, status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Only applicable for EOR contracts. First early invoice (EOR funding statement) for the contract, if any |
amount | string | Optional | Invoice amount |
currency | string | Optional | Currency code for the invoice amount |
description | string | Optional | Invoice description |
due_date | JSON | Optional | |
due_date (anyOf 1) | string | Alternative | Due date for the invoice Format: date-time |
due_date (anyOf 2) | null | Alternative | Due date for the invoice Format: date-time |
id | string | Optional | Unique invoice ID |
paid_at | JSON | Optional | |
paid_at (anyOf 1) | string | Alternative | Timestamp when the invoice was paid, if applicable Format: date-time |
paid_at (anyOf 2) | null | Alternative | Timestamp when the invoice was paid, if applicable Format: date-time |
status | string | Optional | Status of the invoice Known values: OPEN, PENDING, SKIPPED, PREPROCESSING, PROCESSING, CREDITED, PROCESSED, PAID, FAILED, CANCELLED, REFUNDED, UNPAYABLE, AWAITING_PAYMENT |
Get onboarding details by onboarding tracker ID — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Get onboarding details by onboarding tracker ID — 200 response body — data |
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data
Get onboarding details by onboarding tracker ID — 200 response body — data
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data actions item, Get onboarding details by onboarding tracker ID — 200 response body — data app experience, Get onboarding details by onboarding tracker ID — 200 response body — data / banner / severity: ERROR, WARNING, INFO, Get onboarding details by onboarding tracker ID — 200 response body — data banners item, Get onboarding details by onboarding tracker ID — 200 response body — data checklist, Get onboarding details by onboarding tracker ID — 200 response body — data contracts item, Get onboarding details by onboarding tracker ID — 200 response body — data summary item, Get onboarding details by onboarding tracker ID — 200 response body — data hris profile, Get onboarding details by onboarding tracker ID — 200 response body — data profile Employee profile information, Get onboarding details by onboarding tracker ID — 200 response body — data progress, Get onboarding details by onboarding tracker ID — 200 response body — data stepper item, Get onboarding details by onboarding tracker ID — 200 response body — data contract
Get onboarding details by onboarding tracker ID — 200 response body — data / banner / severity: ERROR, WARNING, INFO
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The one thing worth saying about this worker, or null when there is nothing |
action | JSON | Optional | What the client can do about it, when there is something |
action (anyOf 1) | string | Alternative | What the client can do about it, when there is something Known values: CANCEL_CONTRACT, REVIEW_EMPLOYEE_AGREEMENT, PAY_DEPOSIT, VIEW_CONTRACT, SET_UP_HEALTH_SAFETY |
action (anyOf 2) | null | Alternative | |
key | Model | Optional | Expand Get onboarding details by onboarding tracker ID — 200 response body — data banners item key What the banner is about |
severity | string | Optional | How serious it is Known values: ERROR, WARNING, INFO |
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data banners item key
Get onboarding details by onboarding tracker ID — 200 response body — data actions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
available | boolean | Optional | Whether the action can be taken now |
data | object | Optional | Details the action needs, which vary by action Additional keys: see wildcard field |
data.* | JSON | Additional keys | Any type |
last_execution_at | JSON | Optional | |
last_execution_at (anyOf 1) | string | Alternative | When the action was last taken, if ever Format: date-time |
last_execution_at (anyOf 2) | null | Alternative | When the action was last taken, if ever Format: date-time |
type | string | Optional | The action Known values: MANAGE_INVITE, RESEND_INVITE, SEND_REMINDER, CANCEL_CONTRACT, END_CONTRACT, GET_HELP |
Get onboarding details by onboarding tracker ID — 200 response body — data app experience
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The app experience of the employee |
experience_type | JSON | Optional | The app experience the employee is given, when there is a specific one |
experience_type (anyOf 1) | string | Alternative | The app experience the employee is given, when there is a specific one Known values: LIGHTWEIGHT |
experience_type (anyOf 2) | null | Alternative | |
is_minimal_requirements | boolean | Optional | Whether the worker gets the minimal app experience, as a person without a contract does |
Get onboarding details by onboarding tracker ID — 200 response body — data banners item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
action | JSON | Optional | What the client can do about it, when there is something |
action (anyOf 1) | string | Alternative | What the client can do about it, when there is something Known values: CANCEL_CONTRACT, REVIEW_EMPLOYEE_AGREEMENT, PAY_DEPOSIT, VIEW_CONTRACT, SET_UP_HEALTH_SAFETY |
action (anyOf 2) | null | Alternative | |
key | Model | Optional | Expand Get onboarding details by onboarding tracker ID — 200 response body — data banners item key What the banner is about |
severity | string | Optional | How serious it is Known values: ERROR, WARNING, INFO |
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data banners item key
Get onboarding details by onboarding tracker ID — 200 response body — data banners item key
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | What the banner is about Known values: DOCUMENT_REJECTED, CONTRACT_REDLINING, ONBOARDING_OVERDUE, ONBOARDING_AT_RISK, START_DATE_PASSED_WITHOUT_INVITE, EMPLOYEE_AGREEMENT_AWAITING_REVIEW, AWAITING_DEPOSIT_PAYMENT, HS_OBLIGATIONS_PENDING, CONTRACT_AMENDMENTS_IN_PROGRESS, QUOTE_REQUIRES_CHANGES, DRAFT_QUOTE, CONTRACT_DRAFT, QUOTE_READY_TO_ACCEPT, NO_APP_ACCESS, NO_ONBOARDING_STEPS, IN_REVIEW_WITH_DEEL, IN_OFFER_STAGE, PENDING_INVITE, INVITED, ONBOARDING |
Get onboarding details by onboarding tracker ID — 200 response body — data checklist
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | List of checklist steps |
steps | array | Optional | List of checklist steps |
steps[] | Model | Each item | Expand Get onboarding details by onboarding tracker ID — 200 response body — data checklist steps item |
summary | Model | Optional | Expand Get onboarding details by onboarding tracker ID — 200 response body — data checklist summary How far along the checklist is |
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data checklist steps item, Get onboarding details by onboarding tracker ID — 200 response body — data checklist summary
Get onboarding details by onboarding tracker ID — 200 response body — data checklist steps item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Checklist step information |
category | JSON | Optional | |
category (anyOf 1) | string | Alternative | Heading the step sits under |
category (anyOf 2) | null | Alternative | Heading the step sits under |
category_key | JSON | Optional | |
category_key (anyOf 1) | string | Alternative | Stable identifier of the heading, which keeps its value when the heading is renamed |
category_key (anyOf 2) | null | Alternative | Stable identifier of the heading, which keeps its value when the heading is renamed |
completed_at | JSON | Optional | |
completed_at (anyOf 1) | string | Alternative | Completion timestamp of the checklist step Format: date-time |
completed_at (anyOf 2) | null | Alternative | Completion timestamp of the checklist step Format: date-time |
data | object | Optional | Details of the step, which vary by step Additional keys: see wildcard field |
data.* | JSON | Additional keys | Any type |
description | string | Optional | What the step asks of the worker |
display_key | JSON | Optional | |
display_key (anyOf 1) | string | Alternative | Stable identifier of the step, the same across every worker type. Null when the step has no catalogue entry |
display_key (anyOf 2) | null | Alternative | Stable identifier of the step, the same across every worker type. Null when the step has no catalogue entry |
due_date | JSON | Optional | |
due_date (anyOf 1) | string | Alternative | When the step is due, when the source carries one Format: date-time |
due_date (anyOf 2) | null | Alternative | When the step is due, when the source carries one Format: date-time |
group | string | Optional | Whether the worker still owes the step Known values: COMPLETED, OUTSTANDING |
label | string | Optional | The label for the checklist step |
ordinal | JSON | Optional | |
ordinal (anyOf 1) | integer | Alternative | Position of the step in the onboarding sequence, starting at one |
ordinal (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
reject_reason | string | Optional | Reason for rejecting the checklist step (It may contain HTML elements) |
state | string | Optional | State of the step, reported the same way for every worker type Known values: NOT_STARTED, IN_PROGRESS, IN_REVIEW, COMPLETED, OVERDUE |
status | string | Optional | Status of the checklist step |
type | string | Optional | The type of checklist step |
Get onboarding details by onboarding tracker ID — 200 response body — data checklist summary
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | How far along the checklist is |
completed | JSON | Optional | |
completed (anyOf 1) | integer | Alternative | Number of completed steps |
completed (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
outstanding | JSON | Optional | |
outstanding (anyOf 1) | integer | Alternative | Number of steps the worker still owes |
outstanding (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total | JSON | Optional | |
total (anyOf 1) | integer | Alternative | Number of checklist steps |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get onboarding details by onboarding tracker ID — 200 response body — data contract
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about the contract |
client_signed_at | JSON | Optional | |
client_signed_at (anyOf 1) | string | Alternative | Timestamp when the client signed the contract Format: date-time |
client_signed_at (anyOf 2) | null | Alternative | Timestamp when the client signed the contract Format: date-time |
completion_date | JSON | Optional | |
completion_date (anyOf 1) | string | Alternative | The completion date of the contract, if applicable Format: date-time |
completion_date (anyOf 2) | null | Alternative | The completion date of the contract, if applicable Format: date-time |
contractor_signed_at | JSON | Optional | |
contractor_signed_at (anyOf 1) | string | Alternative | Timestamp when the contractor signed the contract Format: date-time |
contractor_signed_at (anyOf 2) | null | Alternative | Timestamp when the contractor signed the contract Format: date-time |
created_at | string | Optional | Contract creation timestamp Format: date-time |
employee_agreement | Model | Optional | Expand Get onboarding details by onboarding tracker ID — 200 response body — data contract employee agreement Information about the Employment Agreement |
first_early_invoice | JSON | Optional | Applicable only for EOR contracts. First early invoice (EOR funding statement) for the contract, if any |
first_early_invoice (anyOf 1) | Model | Alternative | Expand Get onboarding details by onboarding tracker ID — 200 response body — data contract first early invoice amount, currency, description, due date, id, paid at, status |
first_early_invoice (anyOf 2) | null | Alternative | |
first_sign | string | Optional | The first sign (either 'client' or 'contractor') |
id | string | Optional | Unique contract ID |
invited_contractor_email | JSON | Optional | |
invited_contractor_email (anyOf 1) | string | Alternative | Email of the invited contractor Format: email |
invited_contractor_email (anyOf 2) | null | Alternative | Email of the invited contractor Format: email |
is_pwac | boolean | Optional | Whether the worker is a person without a contract |
name | string | Optional | Contract name |
oid | string | Optional | Contract OID |
status | string | Optional | Contract status (e.g., in_progress) |
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data contract employee agreement, Get onboarding details by onboarding tracker ID — 200 response body — data contract first early invoice amount, currency, description, due date, id, paid at, status
Get onboarding details by onboarding tracker ID — 200 response body — data contract employee agreement
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about the Employment Agreement |
phase | JSON | Optional | Signing-lifecycle phase that produced the current Employment Agreement PDF. Can be null if the EA has not yet been generated |
phase (anyOf 1) | string | Alternative | Signing-lifecycle phase that produced the current Employment Agreement PDF. Can be null if the EA has not yet been generated Known values: unsigned, employee_signed, countersigned |
phase (anyOf 2) | null | Alternative | |
status | JSON | Optional | |
status (anyOf 1) | string | Alternative | Status of the Employment Agreement. Can be null if the EA has not yet been generated |
status (anyOf 2) | null | Alternative | Status of the Employment Agreement. Can be null if the EA has not yet been generated |
version_hash | JSON | Optional | |
version_hash (anyOf 1) | string | Alternative | Version of the Employment Agreement. Can be null if the EA has not yet been generated |
version_hash (anyOf 2) | null | Alternative | Version of the Employment Agreement. Can be null if the EA has not yet been generated |
Get onboarding details by onboarding tracker ID — 200 response body — data contract first early invoice amount, currency, description, due date, id, paid at, status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Applicable only for EOR contracts. First early invoice (EOR funding statement) for the contract, if any |
amount | string | Optional | Invoice amount |
currency | string | Optional | Currency code for the invoice amount |
description | string | Optional | Invoice description |
due_date | JSON | Optional | |
due_date (anyOf 1) | string | Alternative | Due date for the invoice Format: date-time |
due_date (anyOf 2) | null | Alternative | Due date for the invoice Format: date-time |
id | string | Optional | Unique invoice ID |
paid_at | JSON | Optional | |
paid_at (anyOf 1) | string | Alternative | Timestamp when the invoice was paid, if applicable Format: date-time |
paid_at (anyOf 2) | null | Alternative | Timestamp when the invoice was paid, if applicable Format: date-time |
status | string | Optional | Status of the invoice Known values: OPEN, PENDING, SKIPPED, PREPROCESSING, PROCESSING, CREDITED, PROCESSED, PAID, FAILED, CANCELLED, REFUNDED, UNPAYABLE, AWAITING_PAYMENT |
Get onboarding details by onboarding tracker ID — 200 response body — data contracts item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contract_oid | JSON | Optional | |
contract_oid (anyOf 1) | string | Alternative | The unique identifier for the contract |
contract_oid (anyOf 2) | null | Alternative | The unique identifier for the contract |
entity | JSON | Optional | The legal entity the contract sits under. Null when there is none |
entity (anyOf 1) | Model | Alternative | Expand Get onboarding details by onboarding tracker ID — 200 response body — data contracts item entity id, name |
entity (anyOf 2) | null | Alternative | |
is_attention_needed | boolean | Optional | Whether the onboarding on this contract is overdue or at risk |
is_current | boolean | Optional | Whether this is the contract the overview is about |
is_main | boolean | Optional | Whether this is the main contract of the worker: the most urgent status, then a new contract before a person without a contract, then the latest start date, then the latest created contract |
is_pwac | boolean | Optional | Whether the contract is the placeholder contract of a person without a contract |
job_title | JSON | Optional | |
job_title (anyOf 1) | string | Alternative | The job title on the contract |
job_title (anyOf 2) | null | Alternative | The job title on the contract |
lifecycle_status | string | Optional | Lifecycle status of this contract, the same value the People list shows for it Known values: DRAFT, IN_REVIEW, QUOTE_REQUIRES_CHANGES, PENDING_INVITE, INVITED, ONBOARDING, ONBOARDING_AT_RISK, ONBOARDING_OVERDUE, OFFBOARDING, ONBOARDED |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | The start date of the contract Format: date |
start_date (anyOf 2) | null | Alternative | The start date of the contract Format: date |
status | string | Optional | Current status of the onboarding on this contract Known values: ONBOARDING_AT_RISK, ONBOARDING_OVERDUE, INVITED, ONBOARDING, READY_TO_START, INACTIVE, PENDING_INVITE, ACTIVE, DRAFT, OFFBOARDING, QUOTE_REQUIRES_CHANGES, IN_REVIEW, IN_OFFER_STAGE |
tracker_id | string | Optional | The tracker identifier that loads this contract |
worker_type | string | Optional | The worker type of the contract, as the hiring_types filter takes it Known values: contractor, direct_employee, hris_direct_employee, hris_direct_contractor, eor, peo, person_without_contract |
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data contracts item entity id, name
Get onboarding details by onboarding tracker ID — 200 response body — data contracts item entity id, name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The legal entity the contract sits under. Null when there is none |
id | string | Optional | The unique identifier for the legal entity |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the legal entity. A Deel entity that a contractor of record works under ends in (COR) |
name (anyOf 2) | null | Alternative | The name of the legal entity. A Deel entity that a contractor of record works under ends in (COR) |
Get onboarding details by onboarding tracker ID — 200 response body — data hris profile
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Employee HRIS profile information |
direct_manager | JSON | Optional | The direct manager of the employee, when one is set |
direct_manager (anyOf 1) | Model | Alternative | Expand Get onboarding details by onboarding tracker ID — 200 response body — data hris profile direct manager job title, name, oid, pic url, work email |
direct_manager (anyOf 2) | null | Alternative | |
email | string | Optional | Email of the HRIS profile Format: email |
invitations | array | Optional | Invitations to the employee that are not sent yet |
invitations[] | Model | Each item | Expand Get onboarding details by onboarding tracker ID — 200 response body — data hris profile invitations item |
name | string | Optional | HRIS Profile name |
oid | string | Optional | HRIS Profile OID |
work_email | JSON | Optional | |
work_email (anyOf 1) | string | Alternative | Work email of the HRIS profile Format: email |
work_email (anyOf 2) | null | Alternative | Work email of the HRIS profile Format: email |
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data hris profile direct manager job title, name, oid, pic url, work email, Get onboarding details by onboarding tracker ID — 200 response body — data hris profile invitations item
Get onboarding details by onboarding tracker ID — 200 response body — data hris profile direct manager job title, name, oid, pic url, work email
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The direct manager of the employee, when one is set |
job_title | JSON | Optional | |
job_title (anyOf 1) | string | Alternative | Job title of the manager |
job_title (anyOf 2) | null | Alternative | Job title of the manager |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Name of the manager |
name (anyOf 2) | null | Alternative | Name of the manager |
oid | string | Optional | HRIS profile OID of the manager |
pic_url | JSON | Optional | |
pic_url (anyOf 1) | string | Alternative | URL of the manager profile picture |
pic_url (anyOf 2) | null | Alternative | URL of the manager profile picture |
work_email | JSON | Optional | |
work_email (anyOf 1) | string | Alternative | Work email of the manager Format: email |
work_email (anyOf 2) | null | Alternative | Work email of the manager Format: email |
Get onboarding details by onboarding tracker ID — 200 response body — data hris profile invitations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
oid | string | Optional | Invitation OID |
send_at | JSON | Optional | |
send_at (anyOf 1) | string | Alternative | When the invitation is or was sent Format: date-time |
send_at (anyOf 2) | null | Alternative | When the invitation is or was sent Format: date-time |
status | string | Optional | Status of the invitation Known values: SENT, DISABLED, SUSPENDED, SCHEDULED, FAILED |
timezone | JSON | Optional | |
timezone (anyOf 1) | string | Alternative | Timezone the invitation is scheduled in |
timezone (anyOf 2) | null | Alternative | Timezone the invitation is scheduled in |
Get onboarding details by onboarding tracker ID — 200 response body — data profile Employee profile information
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Employee profile information |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Country code |
country (anyOf 2) | null | Alternative | Country code |
email | string | Optional | Email of the profile Format: email |
id | JSON | Optional | |
id (anyOf 1) | integer | Alternative | Internal ID of the profile |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
last_login | string | Optional | Last login timestamp Format: date-time |
name | string | Optional | Name associated with the profile |
paid_invoices | array | Optional | A paid invoice on the contract, if any, at most one. Only for a contractor, empty for other worker types |
paid_invoices[] | Model | Each item | Expand Get onboarding details by onboarding tracker ID — 200 response body — data profile Employee profile information paid invoices item |
pic_url | JSON | Optional | |
pic_url (anyOf 1) | string | Alternative | URL of the profile picture |
pic_url (anyOf 2) | null | Alternative | URL of the profile picture |
previously_onboarded | boolean | Optional | Indicates if the contractor has previously onboarded |
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data profile Employee profile information paid invoices item
Get onboarding details by onboarding tracker ID — 200 response body — data profile Employee profile information paid invoices item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | JSON | Optional | |
id (anyOf 1) | integer | Alternative | Internal ID of the invoice |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
status | string | Optional | Status of the invoice |
Get onboarding details by onboarding tracker ID — 200 response body — data progress
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Progress of the onboarding process |
is_action_required_from_client | boolean | Optional | Indicates if action is required from the client |
reference_date | string | Optional | Reference date for the progress Format: date-time |
reference_date_timezone | string | Optional | Timezone of the reference date |
status | string | Optional | Current status of the onboarding process (e.g., ACTIVE) |
sub_status | JSON | Optional | Finer state within the status, when there is one |
sub_status (anyOf 1) | string | Alternative | Finer state within the status, when there is one Known values: PENDING_INVITE, INVITED, ONBOARDING, AWAITING_CLIENT_REVIEW, CANCELLED, REJECTED |
sub_status (anyOf 2) | null | Alternative | |
subject_to_overdue | boolean | Optional | Indicates if the onboarding is subject to overdue |
Get onboarding details by onboarding tracker ID — 200 response body — data stepper item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Stepper action information |
completed_at | JSON | Optional | |
completed_at (anyOf 1) | string | Alternative | Completion timestamp of the stepper action Format: date-time |
completed_at (anyOf 2) | null | Alternative | Completion timestamp of the stepper action Format: date-time |
data | Model | Optional | Expand Get onboarding details by onboarding tracker ID — 200 response body — data stepper item data |
type | string | Optional | Type of the stepper action |
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data stepper item data
Get onboarding details by onboarding tracker ID — 200 response body — data stepper item data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
completed | JSON | Optional | |
completed (anyOf 1) | integer | Alternative | Checklist steps completed, on the checklist progress step |
completed (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
emails | array | Optional | List of emails sent during the stepper process |
emails[] | Model | Each item | Expand Get onboarding details by onboarding tracker ID — 200 response body — data stepper item data emails item |
next_reminder_date | JSON | Optional | |
next_reminder_date (anyOf 1) | string | Alternative | Next reminder date, if applicable Format: date-time |
next_reminder_date (anyOf 2) | null | Alternative | Next reminder date, if applicable Format: date-time |
onboarding_due_date | JSON | Optional | |
onboarding_due_date (anyOf 1) | string | Alternative | When onboarding is due, on the checklist progress step Format: date-time |
onboarding_due_date (anyOf 2) | null | Alternative | When onboarding is due, on the checklist progress step Format: date-time |
remaining | JSON | Optional | |
remaining (anyOf 1) | integer | Alternative | Checklist steps remaining, on the checklist progress step |
remaining (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total | JSON | Optional | |
total (anyOf 1) | integer | Alternative | Checklist steps in total, on the checklist progress step |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data stepper item data emails item
Get onboarding details by onboarding tracker ID — 200 response body — data stepper item data emails item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
meta | Model | Optional | Expand Get onboarding details by onboarding tracker ID — 200 response body — data stepper item data emails item meta Email metadata |
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data stepper item data emails item meta
Get onboarding details by onboarding tracker ID — 200 response body — data stepper item data emails item meta
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Email metadata |
email | string | Optional | Email address Format: email |
sent_at | string | Optional | Timestamp when the email was sent Format: date-time |
type | string | Optional | Type of email |
Get onboarding details by onboarding tracker ID — 200 response body — data summary item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Summary item information |
data | Model | Optional | Expand Get onboarding details by onboarding tracker ID — 200 response body — data summary item data Additional data about the summary item |
name | string | Optional | Name of the summary item |
type | string | Optional | Type of the summary item |
value | Model | Optional | Expand Get onboarding details by onboarding tracker ID — 200 response body — data summary item value Value of the summary item |
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data summary item data, Get onboarding details by onboarding tracker ID — 200 response body — data summary item value
Get onboarding details by onboarding tracker ID — 200 response body — data summary item data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional data about the summary item |
country | string | Optional | Country code for location-related summaries |
has_withdraw_methods | boolean | Optional | Indicates if withdrawal methods exist |
timezone | string | Optional | Timezone information |
Get onboarding details by onboarding tracker ID — 200 response body — data summary item value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Value of the summary item |
$ (anyOf 1) | string | Alternative | |
$ (anyOf 2) | JSON | Alternative | |
$ (anyOf 2) (anyOf 1) | number | Alternative | Format: double |
$ (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3) | boolean | Alternative | |
$ (anyOf 4) | string | Alternative | Format: date-time |
$ (anyOf 5) | object | Alternative | Additional keys: see wildcard field |
$ (anyOf 5).* | JSON | Additional keys | Any type |
List onboarding employees — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | |
data[] | Model | Each item | Expand List onboarding employees — 200 response body — data item |
page | Model | Optional | Expand List onboarding employees — 200 response body — page |
Referenced models: List onboarding employees — 200 response body — data item, List onboarding employees — 200 response body — page
List onboarding employees — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
app_experience | Model | Optional | Expand List onboarding employees — 200 response body — data item app experience The app experience of the employee |
can_send_invitation | boolean | Optional | Only for a Global Payroll direct employee, when the organization sends app invitations. Whether the invitation to the app can be sent: the employee has app access and has not signed up yet |
contract | Model | Optional | Expand List onboarding employees — 200 response body — data item contract The contract associated with the onboarding |
contracts | array | Optional | Every contract of the worker the caller can see, the main one first, so each row of the worker lists the same contracts. A worker has one row per worker type, so the main contract can belong to another row: compare `contract_oid` with `contract.id`. Empty for a draft quote |
contracts[] | Model | Each item | Expand List onboarding employees — 200 response body — data item contracts item |
country | Model | Optional | Expand List onboarding employees — 200 response body — data item country The country of the contract |
hiring_type | string | Optional | The type of hiring (e.g., contractor) |
hris_profile | Model | Optional | Expand List onboarding employees — 200 response body — data item hris profile The profile associated with the onboarding |
invitation_sent | boolean | Optional | Only for a Global Payroll direct employee, when the organization sends app invitations. Whether the invitation to the app was sent and the employee has not signed up yet |
name | string | Optional | The name associated with the onboarding |
overview | JSON | Optional | Only with `include_overview`. The onboarding overview of the contract, as `GET /onboarding/tracker/{tracker_id}` returns it in `data` |
overview (anyOf 1) | Model | Alternative | Expand List onboarding employees — 200 response body — data item overview actions, app experience, banner, banners, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary |
overview (anyOf 2) | null | Alternative | |
pending_steps | string | Optional | Only with `include_overview`. The labels of the checklist steps not done yet, comma separated |
profile | Model | Optional | Expand List onboarding employees — 200 response body — data item profile Only when the worker has an avatar |
progress | Model | Optional | Expand List onboarding employees — 200 response body — data item progress The progress state of the onboarding |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | The start date of the contract Format: date |
start_date (anyOf 2) | null | Alternative | The start date of the contract Format: date |
unique_id | string | Optional | A unique identifier for the tracker |
worker | Model | Optional | Expand List onboarding employees — 200 response body — data item worker The worker being onboarded |
Referenced models: List onboarding employees — 200 response body — data item profile, List onboarding employees — 200 response body — data item app experience, List onboarding employees — 200 response body — data item contract, List onboarding employees — 200 response body — data item contracts item, List onboarding employees — 200 response body — data item country, List onboarding employees — 200 response body — data item hris profile, List onboarding employees — 200 response body — data item overview actions, app experience, banner, banners, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary, List onboarding employees — 200 response body — data item progress, List onboarding employees — 200 response body — data item worker
List onboarding employees — 200 response body — data item app experience
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The app experience of the employee |
experience_type | JSON | Optional | The app experience the employee is given, when there is a specific one |
experience_type (anyOf 1) | string | Alternative | The app experience the employee is given, when there is a specific one Known values: LIGHTWEIGHT |
experience_type (anyOf 2) | null | Alternative | |
is_minimal_requirements | boolean | Optional | Indicates if the employee meets minimal requirements |
List onboarding employees — 200 response body — data item contract
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The contract associated with the onboarding |
effective_date | JSON | Optional | |
effective_date (anyOf 1) | string | Alternative | The effective date of the contract. Null for a person without a contract Format: date |
effective_date (anyOf 2) | null | Alternative | The effective date of the contract. Null for a person without a contract Format: date |
eor | Model | Optional | Expand List onboarding employees — 200 response body — data item contract eor Only for an EOR contract |
global_payroll | Model | Optional | Expand List onboarding employees — 200 response body — data item contract global payroll Only for a Global Payroll direct employee |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The unique identifier for the contract. Null for a person without a contract |
id (anyOf 2) | null | Alternative | The unique identifier for the contract. Null for a person without a contract |
is_pwac | boolean | Optional | Whether the worker is a person without a contract |
offer_letter_id | string | Optional | Only for an EOR contract with an offer letter. The identifier of the offer letter Format: uuid |
Referenced models: List onboarding employees — 200 response body — data item contract global payroll, List onboarding employees — 200 response body — data item contract eor
List onboarding employees — 200 response body — data item contract eor
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Only for an EOR contract |
has_additional_active_eor_contracts | boolean | Optional | Whether the employee has other active EOR contracts |
is_unassigned_candidate | JSON | Optional | |
is_unassigned_candidate (anyOf 1) | boolean | Alternative | Whether the candidate still waits to be assigned through the Deel interview process |
is_unassigned_candidate (anyOf 2) | null | Alternative | Whether the candidate still waits to be assigned through the Deel interview process |
List onboarding employees — 200 response body — data item contract global payroll
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Only for a Global Payroll direct employee |
has_direct_employee_app | boolean | Optional | Whether the employee has access to the app |
List onboarding employees — 200 response body — data item contracts item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contract_oid | JSON | Optional | |
contract_oid (anyOf 1) | string | Alternative | The unique identifier for the contract |
contract_oid (anyOf 2) | null | Alternative | The unique identifier for the contract |
entity | JSON | Optional | The legal entity the contract sits under. Null when there is none |
entity (anyOf 1) | Model | Alternative | Expand Get onboarding details by onboarding tracker ID — 200 response body — data contracts item entity id, name |
entity (anyOf 2) | null | Alternative | |
is_attention_needed | boolean | Optional | Whether the onboarding on this contract is overdue or at risk |
is_main | boolean | Optional | Whether this is the main contract of the worker: the most urgent status, then a new contract before a person without a contract, then the latest start date, then the latest created contract |
is_pwac | boolean | Optional | Whether the contract is the placeholder contract of a person without a contract |
job_title | JSON | Optional | |
job_title (anyOf 1) | string | Alternative | The job title on the contract |
job_title (anyOf 2) | null | Alternative | The job title on the contract |
lifecycle_status | string | Optional | Lifecycle status of this contract, the same value the People list shows for it Known values: DRAFT, IN_REVIEW, QUOTE_REQUIRES_CHANGES, PENDING_INVITE, INVITED, ONBOARDING, ONBOARDING_AT_RISK, ONBOARDING_OVERDUE, OFFBOARDING, ONBOARDED |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | The start date of the contract Format: date |
start_date (anyOf 2) | null | Alternative | The start date of the contract Format: date |
status | string | Optional | Current status of the onboarding on this contract Known values: ONBOARDING_AT_RISK, ONBOARDING_OVERDUE, INVITED, ONBOARDING, READY_TO_START, INACTIVE, PENDING_INVITE, ACTIVE, DRAFT, OFFBOARDING, QUOTE_REQUIRES_CHANGES, IN_REVIEW, IN_OFFER_STAGE |
tracker_id | string | Optional | The tracker identifier that loads this contract |
worker_type | string | Optional | The worker type of the contract, as the hiring_types filter takes it Known values: contractor, direct_employee, hris_direct_employee, hris_direct_contractor, eor, peo, person_without_contract |
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data contracts item entity id, name
List onboarding employees — 200 response body — data item country
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The country of the contract |
code | JSON | Optional | |
code (anyOf 1) | string | Alternative | ISO 3166-1 alpha-2 country code |
code (anyOf 2) | null | Alternative | ISO 3166-1 alpha-2 country code |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The country display name |
name (anyOf 2) | null | Alternative | The country display name |
List onboarding employees — 200 response body — data item hris profile
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The profile associated with the onboarding |
oid | string | Optional | The unique identifier for the HRIS profile |
work_email | JSON | Optional | |
work_email (anyOf 1) | string | Alternative | The work email of the employee |
work_email (anyOf 2) | null | Alternative | The work email of the employee |
List onboarding employees — 200 response body — data item overview actions, app experience, banner, banners, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data actions item, Get onboarding details by onboarding tracker ID — 200 response body — data app experience, Get onboarding details by onboarding tracker ID — 200 response body — data / banner / severity: ERROR, WARNING, INFO, Get onboarding details by onboarding tracker ID — 200 response body — data banners item, Get onboarding details by onboarding tracker ID — 200 response body — data checklist, List onboarding employees — 200 response body — data item overview actions, app experience, banner, banners, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary contract, Get onboarding details by onboarding tracker ID — 200 response body — data contracts item, List onboarding employees — 200 response body — data item overview actions, app experience, banner, banners, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary hris profile Employee HRIS profile information, List onboarding employees — 200 response body — data item overview actions, app experience, banner, banners, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary profile Employee profile information, List onboarding employees — 200 response body — data item overview actions, app experience, banner, banners, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary progress, List onboarding employees — 200 response body — data item overview actions, app experience, banner, banners, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary stepper item, Get onboarding details by onboarding tracker ID — 200 response body — data summary item
List onboarding employees — 200 response body — data item overview actions, app experience, banner, banners, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary contract
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about the contract |
client_signed_at | JSON | Optional | |
client_signed_at (anyOf 1) | string | Alternative | Timestamp when the client signed the contract Format: date-time |
client_signed_at (anyOf 2) | null | Alternative | Timestamp when the client signed the contract Format: date-time |
completion_date | JSON | Optional | |
completion_date (anyOf 1) | string | Alternative | The completion date of the contract, if applicable Format: date-time |
completion_date (anyOf 2) | null | Alternative | The completion date of the contract, if applicable Format: date-time |
contractor_signed_at | JSON | Optional | |
contractor_signed_at (anyOf 1) | string | Alternative | Timestamp when the contractor signed the contract Format: date-time |
contractor_signed_at (anyOf 2) | null | Alternative | Timestamp when the contractor signed the contract Format: date-time |
created_at | string | Optional | Contract creation timestamp Format: date-time |
employee_agreement | JSON | Optional | Information about the Employment Agreement |
employee_agreement (anyOf 1) | Model | Alternative | Expand Get onboarding details by onboarding tracker ID — 200 response body — data contract employee agreement |
employee_agreement (anyOf 2) | null | Alternative | |
first_early_invoice | JSON | Optional | Applicable only for EOR contracts. First early invoice (EOR funding statement) for the contract, if any |
first_early_invoice (anyOf 1) | Model | Alternative | Expand List onboarding employees — 200 response body — data item overview actions, app experience, banner, banners, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary contract first early invoice amount, currency, description, due date, id, paid at, status |
first_early_invoice (anyOf 2) | null | Alternative | |
first_sign | JSON | Optional | |
first_sign (anyOf 1) | string | Alternative | The first sign (either 'client' or 'contractor') |
first_sign (anyOf 2) | null | Alternative | The first sign (either 'client' or 'contractor') |
id | string | Optional | Unique contract ID |
invited_contractor_email | JSON | Optional | |
invited_contractor_email (anyOf 1) | string | Alternative | Email of the invited contractor Format: email |
invited_contractor_email (anyOf 2) | null | Alternative | Email of the invited contractor Format: email |
is_pwac | boolean | Optional | Whether the worker is a person without a contract |
name | string | Optional | Contract name |
oid | string | Optional | Contract OID |
status | JSON | Optional | |
status (anyOf 1) | string | Alternative | Contract status (e.g., in_progress) |
status (anyOf 2) | null | Alternative | Contract status (e.g., in_progress) |
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data contract employee agreement, List onboarding employees — 200 response body — data item overview actions, app experience, banner, banners, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary contract first early invoice amount, currency, description, due date, id, paid at, status
List onboarding employees — 200 response body — data item overview actions, app experience, banner, banners, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary contract first early invoice amount, currency, description, due date, id, paid at, status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Applicable only for EOR contracts. First early invoice (EOR funding statement) for the contract, if any |
amount | string | Optional | Invoice amount |
currency | string | Optional | Currency code for the invoice amount |
description | string | Optional | Invoice description |
due_date | JSON | Optional | |
due_date (anyOf 1) | string | Alternative | Due date for the invoice Format: date-time |
due_date (anyOf 2) | null | Alternative | Due date for the invoice Format: date-time |
id | string | Optional | Unique invoice ID |
paid_at | JSON | Optional | |
paid_at (anyOf 1) | string | Alternative | Timestamp when the invoice was paid, if applicable Format: date-time |
paid_at (anyOf 2) | null | Alternative | Timestamp when the invoice was paid, if applicable Format: date-time |
status | Model | Optional | Expand List onboarding employees — 200 response body — data item overview actions, app experience, banner, banners, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary contract first early invoice amount, currency, description, due date, id, paid at, status status Status of the invoice |
List onboarding employees — 200 response body — data item overview actions, app experience, banner, banners, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary contract first early invoice amount, currency, description, due date, id, paid at, status status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Status of the invoice Known values: OPEN, PENDING, SKIPPED, PREPROCESSING, PROCESSING, CREDITED, PROCESSED, PAID, FAILED, CANCELLED, REFUNDED, UNPAYABLE, AWAITING_PAYMENT, open, pending, skipped, preprocessing, processing, credited, processed, paid, failed, cancelled, refunded, unpayable, awaiting_payment |
List onboarding employees — 200 response body — data item overview actions, app experience, banner, banners, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary hris profile Employee HRIS profile information
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Employee HRIS profile information |
direct_manager | JSON | Optional | The direct manager of the employee, when one is set |
direct_manager (anyOf 1) | Model | Alternative | Expand Get onboarding details by onboarding tracker ID — 200 response body — data hris profile direct manager job title, name, oid, pic url, work email |
direct_manager (anyOf 2) | null | Alternative | |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | Email of the HRIS profile Format: email |
email (anyOf 2) | null | Alternative | Email of the HRIS profile Format: email |
invitations | array | Optional | Invitations to the employee that are not sent yet |
invitations[] | Model | Each item | Expand Get onboarding details by onboarding tracker ID — 200 response body — data hris profile invitations item |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | HRIS Profile name |
name (anyOf 2) | null | Alternative | HRIS Profile name |
oid | JSON | Optional | |
oid (anyOf 1) | string | Alternative | HRIS Profile OID |
oid (anyOf 2) | null | Alternative | HRIS Profile OID |
work_email | JSON | Optional | |
work_email (anyOf 1) | string | Alternative | Work email of the HRIS profile Format: email |
work_email (anyOf 2) | null | Alternative | Work email of the HRIS profile Format: email |
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data hris profile direct manager job title, name, oid, pic url, work email, Get onboarding details by onboarding tracker ID — 200 response body — data hris profile invitations item
List onboarding employees — 200 response body — data item overview actions, app experience, banner, banners, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary profile Employee profile information
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Employee profile information |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Country code |
country (anyOf 2) | null | Alternative | Country code |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | Email of the profile Format: email |
email (anyOf 2) | null | Alternative | Email of the profile Format: email |
id | JSON | Optional | |
id (anyOf 1) | integer | Alternative | Internal ID of the profile |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
last_login | JSON | Optional | |
last_login (anyOf 1) | string | Alternative | Last login timestamp Format: date-time |
last_login (anyOf 2) | null | Alternative | Last login timestamp Format: date-time |
name | string | Optional | Name associated with the profile |
paid_invoices | array | Optional | A paid invoice on the contract, if any, at most one. Only for a contractor, empty for other worker types |
paid_invoices[] | Model | Each item | Expand Get onboarding details by onboarding tracker ID — 200 response body — data profile Employee profile information paid invoices item |
pic_url | JSON | Optional | |
pic_url (anyOf 1) | string | Alternative | URL of the profile picture |
pic_url (anyOf 2) | null | Alternative | URL of the profile picture |
previously_onboarded | boolean | Optional | Indicates if the contractor has previously onboarded |
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data profile Employee profile information paid invoices item
List onboarding employees — 200 response body — data item overview actions, app experience, banner, banners, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary progress
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Progress of the onboarding process |
is_action_required_from_client | boolean | Optional | Indicates if action is required from the client |
reference_date | JSON | Optional | |
reference_date (anyOf 1) | string | Alternative | Reference date for the progress Format: date-time |
reference_date (anyOf 2) | null | Alternative | Reference date for the progress Format: date-time |
reference_date_timezone | JSON | Optional | |
reference_date_timezone (anyOf 1) | string | Alternative | Timezone of the reference date |
reference_date_timezone (anyOf 2) | null | Alternative | Timezone of the reference date |
status | string | Optional | Current status of the onboarding process (e.g., ACTIVE) |
sub_status | JSON | Optional | Finer state within the status, when there is one |
sub_status (anyOf 1) | string | Alternative | Finer state within the status, when there is one Known values: PENDING_INVITE, INVITED, ONBOARDING, AWAITING_CLIENT_REVIEW, CANCELLED, REJECTED |
sub_status (anyOf 2) | null | Alternative | |
subject_to_overdue | boolean | Optional | Indicates if the onboarding is subject to overdue |
List onboarding employees — 200 response body — data item overview actions, app experience, banner, banners, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary stepper item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Stepper action information |
completed_at | JSON | Optional | |
completed_at (anyOf 1) | string | Alternative | Completion timestamp of the stepper action Format: date-time |
completed_at (anyOf 2) | null | Alternative | Completion timestamp of the stepper action Format: date-time |
data | JSON | Optional | |
data (anyOf 1) | Model | Alternative | Expand Get onboarding details by onboarding tracker ID — 200 response body — data stepper item data |
data (anyOf 2) | null | Alternative | |
type | string | Optional | Type of the stepper action |
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data stepper item data
List onboarding employees — 200 response body — data item profile
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Only when the worker has an avatar |
pic_url | string | Optional | The avatar URL of the worker, the same value as `worker.avatar_url` |
List onboarding employees — 200 response body — data item progress
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The progress state of the onboarding |
is_action_required_from_client | JSON | Optional | |
is_action_required_from_client (anyOf 1) | boolean | Alternative | Whether action is required from the client |
is_action_required_from_client (anyOf 2) | null | Alternative | Whether action is required from the client |
lifecycle_status | string | Optional | Lifecycle status of this contract, the same value the People list shows for it Known values: DRAFT, IN_REVIEW, QUOTE_REQUIRES_CHANGES, PENDING_INVITE, INVITED, ONBOARDING, ONBOARDING_AT_RISK, ONBOARDING_OVERDUE, OFFBOARDING, ONBOARDED |
onboarding_due_date | Model | Optional | Expand List onboarding employees — 200 response body — data item progress onboarding due date Due date for onboarding |
people_list_status | string | Optional | Status of the people list |
reference_date | Model | Optional | Expand List onboarding employees — 200 response body — data item progress reference date The reference date determining the onboarding status |
reference_date_timezone | JSON | Optional | |
reference_date_timezone (anyOf 1) | string | Alternative | Timezone of the reference date |
reference_date_timezone (anyOf 2) | null | Alternative | Timezone of the reference date |
reference_date_type | JSON | Optional | |
reference_date_type (anyOf 1) | string | Alternative | Type of the reference date (e.g., EFFECTIVE_DATE) |
reference_date_type (anyOf 2) | null | Alternative | Type of the reference date (e.g., EFFECTIVE_DATE) |
status | string | Optional | Current status of the onboarding |
steps | JSON | Optional | Onboarding checklist step counts per state. Null when the counts are not available: the worker has no checklist yet, the row is a contractor draft or a draft quote, or the steps could not be read |
steps (anyOf 1) | Model | Alternative | Expand List onboarding employees — 200 response body — data item progress steps completed, in progress, in review, not started, overdue, total |
steps (anyOf 2) | null | Alternative | |
sub_status | JSON | Optional | Finer state within the status, when there is one |
sub_status (anyOf 1) | string | Alternative | Finer state within the status, when there is one Known values: PENDING_INVITE, INVITED, ONBOARDING, AWAITING_CLIENT_REVIEW, CANCELLED, REJECTED |
sub_status (anyOf 2) | null | Alternative | |
subject_to_overdue | boolean | Optional | Whether the onboarding is subject to overdue |
waiting_on | JSON | Optional | The party whose action the onboarding waits on. Null when nothing is outstanding, which includes a settled onboarding (READY_TO_START, ACTIVE, OFFBOARDING, INACTIVE) with no client action required |
waiting_on (anyOf 1) | string | Alternative | The party whose action the onboarding waits on. Null when nothing is outstanding, which includes a settled onboarding (READY_TO_START, ACTIVE, OFFBOARDING, INACTIVE) with no client action required Known values: WORKER, CLIENT, DEEL |
waiting_on (anyOf 2) | null | Alternative |
Referenced models: List onboarding employees — 200 response body — data item progress onboarding due date, List onboarding employees — 200 response body — data item progress reference date, List onboarding employees — 200 response body — data item progress steps completed, in progress, in review, not started, overdue, total
List onboarding employees — 200 response body — data item progress onboarding due date
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Due date for onboarding |
$ (anyOf 1) | string | Alternative | Format: date |
$ (anyOf 2) | string | Alternative | Format: date-time |
List onboarding employees — 200 response body — data item progress reference date
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | The reference date determining the onboarding status |
$ (anyOf 1) | string | Alternative | Format: date |
$ (anyOf 2) | string | Alternative | Format: date-time |
$ (anyOf 3) | string | Alternative | Maximum length: 0 |
List onboarding employees — 200 response body — data item progress steps completed, in progress, in review, not started, overdue, total
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Onboarding checklist step counts per state. Null when the counts are not available: the worker has no checklist yet, the row is a contractor draft or a draft quote, or the steps could not be read |
completed | JSON | Optional | |
completed (anyOf 1) | integer | Alternative | Completed steps |
completed (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
in_progress | JSON | Optional | |
in_progress (anyOf 1) | integer | Alternative | Steps started but not completed |
in_progress (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
in_review | JSON | Optional | |
in_review (anyOf 1) | integer | Alternative | Steps waiting for a review |
in_review (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
not_started | JSON | Optional | |
not_started (anyOf 1) | integer | Alternative | Steps not started yet |
not_started (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
overdue | JSON | Optional | |
overdue (anyOf 1) | integer | Alternative | Steps past their due date and not completed |
overdue (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total | JSON | Optional | |
total (anyOf 1) | integer | Alternative | Number of checklist steps |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
List onboarding employees — 200 response body — data item worker
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The worker being onboarded |
avatar_url | JSON | Optional | |
avatar_url (anyOf 1) | string | Alternative | The avatar URL of the worker |
avatar_url (anyOf 2) | null | Alternative | The avatar URL of the worker |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The HRIS profile identifier of the worker. Null for a draft quote |
id (anyOf 2) | null | Alternative | The HRIS profile identifier of the worker. Null for a draft quote |
is_contractor_of_record | boolean | Optional | Whether a contractor is engaged through Contractor of Record |
is_entity_contractor | boolean | Optional | Whether a contractor is engaged through a company rather than as an individual |
job_title | JSON | Optional | |
job_title (anyOf 1) | string | Alternative | The job title on the contract |
job_title (anyOf 2) | null | Alternative | The job title on the contract |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The full name of the worker |
name (anyOf 2) | null | Alternative | The full name of the worker |
List onboarding employees — 200 response body — page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cursor | JSON | Optional | |
cursor (anyOf 1) | string | Alternative | Cursor for pagination |
cursor (anyOf 2) | null | Alternative | Cursor for pagination |
total_rows | JSON | Optional | |
total_rows (anyOf 1) | integer | Alternative | Total number of onboardings matching the filters. Stays the same across every page of a cursor walk. |
total_rows (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |