Skip to content

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

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
actionsarrayOptionalActions the caller can take on this onboarding
actions[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data actions item
app_experienceModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data app experience
The app experience of the employee
bannerJSONOptionalThe one thing worth saying about this worker, or null when there is nothing
banner (anyOf 1)ModelAlternativeExpand Get onboarding details by onboarding tracker ID — 200 response body — data / banner / severity: ERROR, WARNING, INFO
banner (anyOf 2)nullAlternative
bannersarrayOptionalThe banner above, then every other action that waits on the client (deposit, agreement review, H&S)
banners[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data banners item
checklistModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data checklist
List of checklist steps
contractModelOptionalExpand Get onboarding details by employee HRIS profile ID — 200 response body — data contract
Information about the contract
contractsarrayOptionalEvery contract of the worker the caller can see, the main one first
contracts[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data contracts item
hiring_typestringOptionalHiring type (e.g., contractor)
hris_profileModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data hris profile
Employee HRIS profile information
profileJSONOptionalEmployee profile information
profile (anyOf 1)ModelAlternativeExpand Get onboarding details by onboarding tracker ID — 200 response body — data profile Employee profile information
profile (anyOf 2)nullAlternative
progressModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data progress
Progress of the onboarding process
stepperarrayOptionalList of stepper actions taken during the onboarding process
stepper[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data stepper item
summaryarrayOptionalSummary of the onboarding process
summary[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data summary item

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

FieldTypePresenceDescription and constraints
$objectRootInformation about the contract
client_signed_atJSONOptional
client_signed_at (anyOf 1)stringAlternativeTimestamp when the client signed the contract
Format: date-time
client_signed_at (anyOf 2)nullAlternativeTimestamp when the client signed the contract
Format: date-time
completion_dateJSONOptional
completion_date (anyOf 1)stringAlternativeThe completion date of the contract, if applicable
Format: date-time
completion_date (anyOf 2)nullAlternativeThe completion date of the contract, if applicable
Format: date-time
contractor_signed_atJSONOptional
contractor_signed_at (anyOf 1)stringAlternativeTimestamp when the contractor signed the contract
Format: date-time
contractor_signed_at (anyOf 2)nullAlternativeTimestamp when the contractor signed the contract
Format: date-time
created_atstringOptionalContract creation timestamp
Format: date-time
employee_agreementModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data contract employee agreement
Information about the Employment Agreement
first_early_invoiceJSONOptionalOnly applicable for EOR contracts. First early invoice (EOR funding statement) for the contract, if any
first_early_invoice (anyOf 1)ModelAlternativeExpand 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)nullAlternative
first_signstringOptionalThe first sign (either 'client' or 'contractor')
idstringOptionalUnique contract ID
invited_contractor_emailJSONOptional
invited_contractor_email (anyOf 1)stringAlternativeEmail of the invited contractor
Format: email
invited_contractor_email (anyOf 2)nullAlternativeEmail of the invited contractor
Format: email
is_pwacbooleanOptionalWhether the worker is a person without a contract
namestringOptionalContract name
oidstringOptionalContract OID
statusstringOptionalContract 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

FieldTypePresenceDescription and constraints
$objectRootOnly applicable for EOR contracts. First early invoice (EOR funding statement) for the contract, if any
amountstringOptionalInvoice amount
currencystringOptionalCurrency code for the invoice amount
descriptionstringOptionalInvoice description
due_dateJSONOptional
due_date (anyOf 1)stringAlternativeDue date for the invoice
Format: date-time
due_date (anyOf 2)nullAlternativeDue date for the invoice
Format: date-time
idstringOptionalUnique invoice ID
paid_atJSONOptional
paid_at (anyOf 1)stringAlternativeTimestamp when the invoice was paid, if applicable
Format: date-time
paid_at (anyOf 2)nullAlternativeTimestamp when the invoice was paid, if applicable
Format: date-time
statusstringOptionalStatus 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

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
actionsarrayOptionalActions the caller can take on this onboarding
actions[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data actions item
app_experienceModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data app experience
The app experience of the employee
bannerJSONOptionalThe one thing worth saying about this worker, or null when there is nothing
banner (anyOf 1)ModelAlternativeExpand Get onboarding details by onboarding tracker ID — 200 response body — data / banner / severity: ERROR, WARNING, INFO
banner (anyOf 2)nullAlternative
bannersarrayOptionalThe banner above, then every other action that waits on the client (deposit, agreement review, H&S)
banners[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data banners item
checklistModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data checklist
List of checklist steps
contractModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data contract
Information about the contract
contractsarrayOptionalEvery contract of the worker the caller can see, the main one first
contracts[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data contracts item
hiring_typestringOptionalHiring type (e.g., contractor)
hris_profileModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data hris profile
Employee HRIS profile information
profileJSONOptionalEmployee profile information
profile (anyOf 1)ModelAlternativeExpand Get onboarding details by onboarding tracker ID — 200 response body — data profile Employee profile information
profile (anyOf 2)nullAlternative
progressModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data progress
Progress of the onboarding process
stepperarrayOptionalList of stepper actions taken during the onboarding process
stepper[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data stepper item
summaryarrayOptionalSummary of the onboarding process
summary[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data summary item

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

FieldTypePresenceDescription and constraints
$objectRootThe one thing worth saying about this worker, or null when there is nothing
actionJSONOptionalWhat the client can do about it, when there is something
action (anyOf 1)stringAlternativeWhat 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)nullAlternative
keyModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data banners item key
What the banner is about
severitystringOptionalHow 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

FieldTypePresenceDescription and constraints
$objectRoot
availablebooleanOptionalWhether the action can be taken now
dataobjectOptionalDetails the action needs, which vary by action
Additional keys: see wildcard field
data.*JSONAdditional keysAny type
last_execution_atJSONOptional
last_execution_at (anyOf 1)stringAlternativeWhen the action was last taken, if ever
Format: date-time
last_execution_at (anyOf 2)nullAlternativeWhen the action was last taken, if ever
Format: date-time
typestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootThe app experience of the employee
experience_typeJSONOptionalThe app experience the employee is given, when there is a specific one
experience_type (anyOf 1)stringAlternativeThe app experience the employee is given, when there is a specific one
Known values: LIGHTWEIGHT
experience_type (anyOf 2)nullAlternative
is_minimal_requirementsbooleanOptionalWhether 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

FieldTypePresenceDescription and constraints
$objectRoot
actionJSONOptionalWhat the client can do about it, when there is something
action (anyOf 1)stringAlternativeWhat 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)nullAlternative
keyModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data banners item key
What the banner is about
severitystringOptionalHow 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

FieldTypePresenceDescription and constraints
$stringRootWhat 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

FieldTypePresenceDescription and constraints
$objectRootList of checklist steps
stepsarrayOptionalList of checklist steps
steps[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data checklist steps item
summaryModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRootChecklist step information
categoryJSONOptional
category (anyOf 1)stringAlternativeHeading the step sits under
category (anyOf 2)nullAlternativeHeading the step sits under
category_keyJSONOptional
category_key (anyOf 1)stringAlternativeStable identifier of the heading, which keeps its value when the heading is renamed
category_key (anyOf 2)nullAlternativeStable identifier of the heading, which keeps its value when the heading is renamed
completed_atJSONOptional
completed_at (anyOf 1)stringAlternativeCompletion timestamp of the checklist step
Format: date-time
completed_at (anyOf 2)nullAlternativeCompletion timestamp of the checklist step
Format: date-time
dataobjectOptionalDetails of the step, which vary by step
Additional keys: see wildcard field
data.*JSONAdditional keysAny type
descriptionstringOptionalWhat the step asks of the worker
display_keyJSONOptional
display_key (anyOf 1)stringAlternativeStable identifier of the step, the same across every worker type. Null when the step has no catalogue entry
display_key (anyOf 2)nullAlternativeStable identifier of the step, the same across every worker type. Null when the step has no catalogue entry
due_dateJSONOptional
due_date (anyOf 1)stringAlternativeWhen the step is due, when the source carries one
Format: date-time
due_date (anyOf 2)nullAlternativeWhen the step is due, when the source carries one
Format: date-time
groupstringOptionalWhether the worker still owes the step
Known values: COMPLETED, OUTSTANDING
labelstringOptionalThe label for the checklist step
ordinalJSONOptional
ordinal (anyOf 1)integerAlternativePosition of the step in the onboarding sequence, starting at one
ordinal (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
reject_reasonstringOptionalReason for rejecting the checklist step (It may contain HTML elements)
statestringOptionalState of the step, reported the same way for every worker type
Known values: NOT_STARTED, IN_PROGRESS, IN_REVIEW, COMPLETED, OVERDUE
statusstringOptionalStatus of the checklist step
typestringOptionalThe type of checklist step

Get onboarding details by onboarding tracker ID — 200 response body — data checklist summary

FieldTypePresenceDescription and constraints
$objectRootHow far along the checklist is
completedJSONOptional
completed (anyOf 1)integerAlternativeNumber of completed steps
completed (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
outstandingJSONOptional
outstanding (anyOf 1)integerAlternativeNumber of steps the worker still owes
outstanding (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
totalJSONOptional
total (anyOf 1)integerAlternativeNumber of checklist steps
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get onboarding details by onboarding tracker ID — 200 response body — data contract

FieldTypePresenceDescription and constraints
$objectRootInformation about the contract
client_signed_atJSONOptional
client_signed_at (anyOf 1)stringAlternativeTimestamp when the client signed the contract
Format: date-time
client_signed_at (anyOf 2)nullAlternativeTimestamp when the client signed the contract
Format: date-time
completion_dateJSONOptional
completion_date (anyOf 1)stringAlternativeThe completion date of the contract, if applicable
Format: date-time
completion_date (anyOf 2)nullAlternativeThe completion date of the contract, if applicable
Format: date-time
contractor_signed_atJSONOptional
contractor_signed_at (anyOf 1)stringAlternativeTimestamp when the contractor signed the contract
Format: date-time
contractor_signed_at (anyOf 2)nullAlternativeTimestamp when the contractor signed the contract
Format: date-time
created_atstringOptionalContract creation timestamp
Format: date-time
employee_agreementModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data contract employee agreement
Information about the Employment Agreement
first_early_invoiceJSONOptionalApplicable only for EOR contracts. First early invoice (EOR funding statement) for the contract, if any
first_early_invoice (anyOf 1)ModelAlternativeExpand 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)nullAlternative
first_signstringOptionalThe first sign (either 'client' or 'contractor')
idstringOptionalUnique contract ID
invited_contractor_emailJSONOptional
invited_contractor_email (anyOf 1)stringAlternativeEmail of the invited contractor
Format: email
invited_contractor_email (anyOf 2)nullAlternativeEmail of the invited contractor
Format: email
is_pwacbooleanOptionalWhether the worker is a person without a contract
namestringOptionalContract name
oidstringOptionalContract OID
statusstringOptionalContract 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

FieldTypePresenceDescription and constraints
$objectRootInformation about the Employment Agreement
phaseJSONOptionalSigning-lifecycle phase that produced the current Employment Agreement PDF. Can be null if the EA has not yet been generated
phase (anyOf 1)stringAlternativeSigning-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)nullAlternative
statusJSONOptional
status (anyOf 1)stringAlternativeStatus of the Employment Agreement. Can be null if the EA has not yet been generated
status (anyOf 2)nullAlternativeStatus of the Employment Agreement. Can be null if the EA has not yet been generated
version_hashJSONOptional
version_hash (anyOf 1)stringAlternativeVersion of the Employment Agreement. Can be null if the EA has not yet been generated
version_hash (anyOf 2)nullAlternativeVersion 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

FieldTypePresenceDescription and constraints
$objectRootApplicable only for EOR contracts. First early invoice (EOR funding statement) for the contract, if any
amountstringOptionalInvoice amount
currencystringOptionalCurrency code for the invoice amount
descriptionstringOptionalInvoice description
due_dateJSONOptional
due_date (anyOf 1)stringAlternativeDue date for the invoice
Format: date-time
due_date (anyOf 2)nullAlternativeDue date for the invoice
Format: date-time
idstringOptionalUnique invoice ID
paid_atJSONOptional
paid_at (anyOf 1)stringAlternativeTimestamp when the invoice was paid, if applicable
Format: date-time
paid_at (anyOf 2)nullAlternativeTimestamp when the invoice was paid, if applicable
Format: date-time
statusstringOptionalStatus 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

FieldTypePresenceDescription and constraints
$objectRoot
contract_oidJSONOptional
contract_oid (anyOf 1)stringAlternativeThe unique identifier for the contract
contract_oid (anyOf 2)nullAlternativeThe unique identifier for the contract
entityJSONOptionalThe legal entity the contract sits under. Null when there is none
entity (anyOf 1)ModelAlternativeExpand Get onboarding details by onboarding tracker ID — 200 response body — data contracts item entity id, name
entity (anyOf 2)nullAlternative
is_attention_neededbooleanOptionalWhether the onboarding on this contract is overdue or at risk
is_currentbooleanOptionalWhether this is the contract the overview is about
is_mainbooleanOptionalWhether 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_pwacbooleanOptionalWhether the contract is the placeholder contract of a person without a contract
job_titleJSONOptional
job_title (anyOf 1)stringAlternativeThe job title on the contract
job_title (anyOf 2)nullAlternativeThe job title on the contract
lifecycle_statusstringOptionalLifecycle 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_dateJSONOptional
start_date (anyOf 1)stringAlternativeThe start date of the contract
Format: date
start_date (anyOf 2)nullAlternativeThe start date of the contract
Format: date
statusstringOptionalCurrent 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_idstringOptionalThe tracker identifier that loads this contract
worker_typestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootThe legal entity the contract sits under. Null when there is none
idstringOptionalThe unique identifier for the legal entity
nameJSONOptional
name (anyOf 1)stringAlternativeThe name of the legal entity. A Deel entity that a contractor of record works under ends in (COR)
name (anyOf 2)nullAlternativeThe 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

FieldTypePresenceDescription and constraints
$objectRootEmployee HRIS profile information
direct_managerJSONOptionalThe direct manager of the employee, when one is set
direct_manager (anyOf 1)ModelAlternativeExpand 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)nullAlternative
emailstringOptionalEmail of the HRIS profile
Format: email
invitationsarrayOptionalInvitations to the employee that are not sent yet
invitations[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data hris profile invitations item
namestringOptionalHRIS Profile name
oidstringOptionalHRIS Profile OID
work_emailJSONOptional
work_email (anyOf 1)stringAlternativeWork email of the HRIS profile
Format: email
work_email (anyOf 2)nullAlternativeWork 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

FieldTypePresenceDescription and constraints
$objectRootThe direct manager of the employee, when one is set
job_titleJSONOptional
job_title (anyOf 1)stringAlternativeJob title of the manager
job_title (anyOf 2)nullAlternativeJob title of the manager
nameJSONOptional
name (anyOf 1)stringAlternativeName of the manager
name (anyOf 2)nullAlternativeName of the manager
oidstringOptionalHRIS profile OID of the manager
pic_urlJSONOptional
pic_url (anyOf 1)stringAlternativeURL of the manager profile picture
pic_url (anyOf 2)nullAlternativeURL of the manager profile picture
work_emailJSONOptional
work_email (anyOf 1)stringAlternativeWork email of the manager
Format: email
work_email (anyOf 2)nullAlternativeWork email of the manager
Format: email

Get onboarding details by onboarding tracker ID — 200 response body — data hris profile invitations item

FieldTypePresenceDescription and constraints
$objectRoot
oidstringOptionalInvitation OID
send_atJSONOptional
send_at (anyOf 1)stringAlternativeWhen the invitation is or was sent
Format: date-time
send_at (anyOf 2)nullAlternativeWhen the invitation is or was sent
Format: date-time
statusstringOptionalStatus of the invitation
Known values: SENT, DISABLED, SUSPENDED, SCHEDULED, FAILED
timezoneJSONOptional
timezone (anyOf 1)stringAlternativeTimezone the invitation is scheduled in
timezone (anyOf 2)nullAlternativeTimezone the invitation is scheduled in

Get onboarding details by onboarding tracker ID — 200 response body — data profile Employee profile information

FieldTypePresenceDescription and constraints
$objectRootEmployee profile information
countryJSONOptional
country (anyOf 1)stringAlternativeCountry code
country (anyOf 2)nullAlternativeCountry code
emailstringOptionalEmail of the profile
Format: email
idJSONOptional
id (anyOf 1)integerAlternativeInternal ID of the profile
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
last_loginstringOptionalLast login timestamp
Format: date-time
namestringOptionalName associated with the profile
paid_invoicesarrayOptionalA paid invoice on the contract, if any, at most one. Only for a contractor, empty for other worker types
paid_invoices[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data profile Employee profile information paid invoices item
pic_urlJSONOptional
pic_url (anyOf 1)stringAlternativeURL of the profile picture
pic_url (anyOf 2)nullAlternativeURL of the profile picture
previously_onboardedbooleanOptionalIndicates 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

FieldTypePresenceDescription and constraints
$objectRoot
idJSONOptional
id (anyOf 1)integerAlternativeInternal ID of the invoice
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
statusstringOptionalStatus of the invoice

Get onboarding details by onboarding tracker ID — 200 response body — data progress

FieldTypePresenceDescription and constraints
$objectRootProgress of the onboarding process
is_action_required_from_clientbooleanOptionalIndicates if action is required from the client
reference_datestringOptionalReference date for the progress
Format: date-time
reference_date_timezonestringOptionalTimezone of the reference date
statusstringOptionalCurrent status of the onboarding process (e.g., ACTIVE)
sub_statusJSONOptionalFiner state within the status, when there is one
sub_status (anyOf 1)stringAlternativeFiner state within the status, when there is one
Known values: PENDING_INVITE, INVITED, ONBOARDING, AWAITING_CLIENT_REVIEW, CANCELLED, REJECTED
sub_status (anyOf 2)nullAlternative
subject_to_overduebooleanOptionalIndicates if the onboarding is subject to overdue

Get onboarding details by onboarding tracker ID — 200 response body — data stepper item

FieldTypePresenceDescription and constraints
$objectRootStepper action information
completed_atJSONOptional
completed_at (anyOf 1)stringAlternativeCompletion timestamp of the stepper action
Format: date-time
completed_at (anyOf 2)nullAlternativeCompletion timestamp of the stepper action
Format: date-time
dataModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data stepper item data
typestringOptionalType 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

FieldTypePresenceDescription and constraints
$objectRoot
completedJSONOptional
completed (anyOf 1)integerAlternativeChecklist steps completed, on the checklist progress step
completed (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
emailsarrayOptionalList of emails sent during the stepper process
emails[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data stepper item data emails item
next_reminder_dateJSONOptional
next_reminder_date (anyOf 1)stringAlternativeNext reminder date, if applicable
Format: date-time
next_reminder_date (anyOf 2)nullAlternativeNext reminder date, if applicable
Format: date-time
onboarding_due_dateJSONOptional
onboarding_due_date (anyOf 1)stringAlternativeWhen onboarding is due, on the checklist progress step
Format: date-time
onboarding_due_date (anyOf 2)nullAlternativeWhen onboarding is due, on the checklist progress step
Format: date-time
remainingJSONOptional
remaining (anyOf 1)integerAlternativeChecklist steps remaining, on the checklist progress step
remaining (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
totalJSONOptional
total (anyOf 1)integerAlternativeChecklist steps in total, on the checklist progress step
total (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$objectRoot
metaModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRootEmail metadata
emailstringOptionalEmail address
Format: email
sent_atstringOptionalTimestamp when the email was sent
Format: date-time
typestringOptionalType of email

Get onboarding details by onboarding tracker ID — 200 response body — data summary item

FieldTypePresenceDescription and constraints
$objectRootSummary item information
dataModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data summary item data
Additional data about the summary item
namestringOptionalName of the summary item
typestringOptionalType of the summary item
valueModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRootAdditional data about the summary item
countrystringOptionalCountry code for location-related summaries
has_withdraw_methodsbooleanOptionalIndicates if withdrawal methods exist
timezonestringOptionalTimezone information

Get onboarding details by onboarding tracker ID — 200 response body — data summary item value

FieldTypePresenceDescription and constraints
$JSONRootValue of the summary item
$ (anyOf 1)stringAlternative
$ (anyOf 2)JSONAlternative
$ (anyOf 2) (anyOf 1)numberAlternativeFormat: double
$ (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 3)booleanAlternative
$ (anyOf 4)stringAlternativeFormat: date-time
$ (anyOf 5)objectAlternativeAdditional keys: see wildcard field
$ (anyOf 5).*JSONAdditional keysAny type

List onboarding employees — 200 response body

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

FieldTypePresenceDescription and constraints
$objectRoot
app_experienceModelOptionalExpand List onboarding employees — 200 response body — data item app experience
The app experience of the employee
can_send_invitationbooleanOptionalOnly 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
contractModelOptionalExpand List onboarding employees — 200 response body — data item contract
The contract associated with the onboarding
contractsarrayOptionalEvery 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[]ModelEach itemExpand List onboarding employees — 200 response body — data item contracts item
countryModelOptionalExpand List onboarding employees — 200 response body — data item country
The country of the contract
hiring_typestringOptionalThe type of hiring (e.g., contractor)
hris_profileModelOptionalExpand List onboarding employees — 200 response body — data item hris profile
The profile associated with the onboarding
invitation_sentbooleanOptionalOnly 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
namestringOptionalThe name associated with the onboarding
overviewJSONOptionalOnly with `include_overview`. The onboarding overview of the contract, as `GET /onboarding/tracker/{tracker_id}` returns it in `data`
overview (anyOf 1)ModelAlternativeExpand 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)nullAlternative
pending_stepsstringOptionalOnly with `include_overview`. The labels of the checklist steps not done yet, comma separated
profileModelOptionalExpand List onboarding employees — 200 response body — data item profile
Only when the worker has an avatar
progressModelOptionalExpand List onboarding employees — 200 response body — data item progress
The progress state of the onboarding
start_dateJSONOptional
start_date (anyOf 1)stringAlternativeThe start date of the contract
Format: date
start_date (anyOf 2)nullAlternativeThe start date of the contract
Format: date
unique_idstringOptionalA unique identifier for the tracker
workerModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRootThe app experience of the employee
experience_typeJSONOptionalThe app experience the employee is given, when there is a specific one
experience_type (anyOf 1)stringAlternativeThe app experience the employee is given, when there is a specific one
Known values: LIGHTWEIGHT
experience_type (anyOf 2)nullAlternative
is_minimal_requirementsbooleanOptionalIndicates if the employee meets minimal requirements

List onboarding employees — 200 response body — data item contract

FieldTypePresenceDescription and constraints
$objectRootThe contract associated with the onboarding
effective_dateJSONOptional
effective_date (anyOf 1)stringAlternativeThe effective date of the contract. Null for a person without a contract
Format: date
effective_date (anyOf 2)nullAlternativeThe effective date of the contract. Null for a person without a contract
Format: date
eorModelOptionalExpand List onboarding employees — 200 response body — data item contract eor
Only for an EOR contract
global_payrollModelOptionalExpand List onboarding employees — 200 response body — data item contract global payroll
Only for a Global Payroll direct employee
idJSONOptional
id (anyOf 1)stringAlternativeThe unique identifier for the contract. Null for a person without a contract
id (anyOf 2)nullAlternativeThe unique identifier for the contract. Null for a person without a contract
is_pwacbooleanOptionalWhether the worker is a person without a contract
offer_letter_idstringOptionalOnly 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

FieldTypePresenceDescription and constraints
$objectRootOnly for an EOR contract
has_additional_active_eor_contractsbooleanOptionalWhether the employee has other active EOR contracts
is_unassigned_candidateJSONOptional
is_unassigned_candidate (anyOf 1)booleanAlternativeWhether the candidate still waits to be assigned through the Deel interview process
is_unassigned_candidate (anyOf 2)nullAlternativeWhether the candidate still waits to be assigned through the Deel interview process

List onboarding employees — 200 response body — data item contract global payroll

FieldTypePresenceDescription and constraints
$objectRootOnly for a Global Payroll direct employee
has_direct_employee_appbooleanOptionalWhether the employee has access to the app

List onboarding employees — 200 response body — data item contracts item

FieldTypePresenceDescription and constraints
$objectRoot
contract_oidJSONOptional
contract_oid (anyOf 1)stringAlternativeThe unique identifier for the contract
contract_oid (anyOf 2)nullAlternativeThe unique identifier for the contract
entityJSONOptionalThe legal entity the contract sits under. Null when there is none
entity (anyOf 1)ModelAlternativeExpand Get onboarding details by onboarding tracker ID — 200 response body — data contracts item entity id, name
entity (anyOf 2)nullAlternative
is_attention_neededbooleanOptionalWhether the onboarding on this contract is overdue or at risk
is_mainbooleanOptionalWhether 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_pwacbooleanOptionalWhether the contract is the placeholder contract of a person without a contract
job_titleJSONOptional
job_title (anyOf 1)stringAlternativeThe job title on the contract
job_title (anyOf 2)nullAlternativeThe job title on the contract
lifecycle_statusstringOptionalLifecycle 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_dateJSONOptional
start_date (anyOf 1)stringAlternativeThe start date of the contract
Format: date
start_date (anyOf 2)nullAlternativeThe start date of the contract
Format: date
statusstringOptionalCurrent 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_idstringOptionalThe tracker identifier that loads this contract
worker_typestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootThe country of the contract
codeJSONOptional
code (anyOf 1)stringAlternativeISO 3166-1 alpha-2 country code
code (anyOf 2)nullAlternativeISO 3166-1 alpha-2 country code
nameJSONOptional
name (anyOf 1)stringAlternativeThe country display name
name (anyOf 2)nullAlternativeThe country display name

List onboarding employees — 200 response body — data item hris profile

FieldTypePresenceDescription and constraints
$objectRootThe profile associated with the onboarding
oidstringOptionalThe unique identifier for the HRIS profile
work_emailJSONOptional
work_email (anyOf 1)stringAlternativeThe work email of the employee
work_email (anyOf 2)nullAlternativeThe 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

FieldTypePresenceDescription and constraints
$objectRootOnly with `include_overview`. The onboarding overview of the contract, as `GET /onboarding/tracker/{tracker_id}` returns it in `data`
actionsarrayOptionalActions the caller can take on this onboarding
actions[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data actions item
app_experienceModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data app experience
The app experience of the employee
bannerJSONOptionalThe one thing worth saying about this worker, or null when there is nothing
banner (anyOf 1)ModelAlternativeExpand Get onboarding details by onboarding tracker ID — 200 response body — data / banner / severity: ERROR, WARNING, INFO
banner (anyOf 2)nullAlternative
bannersarrayOptionalThe banner above, then every other action that waits on the client (deposit, agreement review, H&S)
banners[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data banners item
checklistModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data checklist
List of checklist steps
contractModelOptionalExpand 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
Information about the contract
contractsarrayOptionalEvery contract of the worker the caller can see, the main one first
contracts[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data contracts item
hiring_typestringOptionalHiring type (e.g., contractor)
hris_profileJSONOptionalEmployee HRIS profile information
hris_profile (anyOf 1)ModelAlternativeExpand 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
hris_profile (anyOf 2)nullAlternative
profileJSONOptionalEmployee profile information
profile (anyOf 1)ModelAlternativeExpand 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
profile (anyOf 2)nullAlternative
progressModelOptionalExpand 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
Progress of the onboarding process
stepperarrayOptionalList of stepper actions taken during the onboarding process
stepper[]ModelEach itemExpand 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
summaryarrayOptionalSummary of the onboarding process
summary[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data summary item

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

FieldTypePresenceDescription and constraints
$objectRootInformation about the contract
client_signed_atJSONOptional
client_signed_at (anyOf 1)stringAlternativeTimestamp when the client signed the contract
Format: date-time
client_signed_at (anyOf 2)nullAlternativeTimestamp when the client signed the contract
Format: date-time
completion_dateJSONOptional
completion_date (anyOf 1)stringAlternativeThe completion date of the contract, if applicable
Format: date-time
completion_date (anyOf 2)nullAlternativeThe completion date of the contract, if applicable
Format: date-time
contractor_signed_atJSONOptional
contractor_signed_at (anyOf 1)stringAlternativeTimestamp when the contractor signed the contract
Format: date-time
contractor_signed_at (anyOf 2)nullAlternativeTimestamp when the contractor signed the contract
Format: date-time
created_atstringOptionalContract creation timestamp
Format: date-time
employee_agreementJSONOptionalInformation about the Employment Agreement
employee_agreement (anyOf 1)ModelAlternativeExpand Get onboarding details by onboarding tracker ID — 200 response body — data contract employee agreement
employee_agreement (anyOf 2)nullAlternative
first_early_invoiceJSONOptionalApplicable only for EOR contracts. First early invoice (EOR funding statement) for the contract, if any
first_early_invoice (anyOf 1)ModelAlternativeExpand 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)nullAlternative
first_signJSONOptional
first_sign (anyOf 1)stringAlternativeThe first sign (either 'client' or 'contractor')
first_sign (anyOf 2)nullAlternativeThe first sign (either 'client' or 'contractor')
idstringOptionalUnique contract ID
invited_contractor_emailJSONOptional
invited_contractor_email (anyOf 1)stringAlternativeEmail of the invited contractor
Format: email
invited_contractor_email (anyOf 2)nullAlternativeEmail of the invited contractor
Format: email
is_pwacbooleanOptionalWhether the worker is a person without a contract
namestringOptionalContract name
oidstringOptionalContract OID
statusJSONOptional
status (anyOf 1)stringAlternativeContract status (e.g., in_progress)
status (anyOf 2)nullAlternativeContract 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

FieldTypePresenceDescription and constraints
$objectRootApplicable only for EOR contracts. First early invoice (EOR funding statement) for the contract, if any
amountstringOptionalInvoice amount
currencystringOptionalCurrency code for the invoice amount
descriptionstringOptionalInvoice description
due_dateJSONOptional
due_date (anyOf 1)stringAlternativeDue date for the invoice
Format: date-time
due_date (anyOf 2)nullAlternativeDue date for the invoice
Format: date-time
idstringOptionalUnique invoice ID
paid_atJSONOptional
paid_at (anyOf 1)stringAlternativeTimestamp when the invoice was paid, if applicable
Format: date-time
paid_at (anyOf 2)nullAlternativeTimestamp when the invoice was paid, if applicable
Format: date-time
statusModelOptionalExpand 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

Referenced models: 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

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

FieldTypePresenceDescription and constraints
$stringRootStatus 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

FieldTypePresenceDescription and constraints
$objectRootEmployee HRIS profile information
direct_managerJSONOptionalThe direct manager of the employee, when one is set
direct_manager (anyOf 1)ModelAlternativeExpand 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)nullAlternative
emailJSONOptional
email (anyOf 1)stringAlternativeEmail of the HRIS profile
Format: email
email (anyOf 2)nullAlternativeEmail of the HRIS profile
Format: email
invitationsarrayOptionalInvitations to the employee that are not sent yet
invitations[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data hris profile invitations item
nameJSONOptional
name (anyOf 1)stringAlternativeHRIS Profile name
name (anyOf 2)nullAlternativeHRIS Profile name
oidJSONOptional
oid (anyOf 1)stringAlternativeHRIS Profile OID
oid (anyOf 2)nullAlternativeHRIS Profile OID
work_emailJSONOptional
work_email (anyOf 1)stringAlternativeWork email of the HRIS profile
Format: email
work_email (anyOf 2)nullAlternativeWork 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

FieldTypePresenceDescription and constraints
$objectRootEmployee profile information
countryJSONOptional
country (anyOf 1)stringAlternativeCountry code
country (anyOf 2)nullAlternativeCountry code
emailJSONOptional
email (anyOf 1)stringAlternativeEmail of the profile
Format: email
email (anyOf 2)nullAlternativeEmail of the profile
Format: email
idJSONOptional
id (anyOf 1)integerAlternativeInternal ID of the profile
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
last_loginJSONOptional
last_login (anyOf 1)stringAlternativeLast login timestamp
Format: date-time
last_login (anyOf 2)nullAlternativeLast login timestamp
Format: date-time
namestringOptionalName associated with the profile
paid_invoicesarrayOptionalA paid invoice on the contract, if any, at most one. Only for a contractor, empty for other worker types
paid_invoices[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data profile Employee profile information paid invoices item
pic_urlJSONOptional
pic_url (anyOf 1)stringAlternativeURL of the profile picture
pic_url (anyOf 2)nullAlternativeURL of the profile picture
previously_onboardedbooleanOptionalIndicates 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

FieldTypePresenceDescription and constraints
$objectRootProgress of the onboarding process
is_action_required_from_clientbooleanOptionalIndicates if action is required from the client
reference_dateJSONOptional
reference_date (anyOf 1)stringAlternativeReference date for the progress
Format: date-time
reference_date (anyOf 2)nullAlternativeReference date for the progress
Format: date-time
reference_date_timezoneJSONOptional
reference_date_timezone (anyOf 1)stringAlternativeTimezone of the reference date
reference_date_timezone (anyOf 2)nullAlternativeTimezone of the reference date
statusstringOptionalCurrent status of the onboarding process (e.g., ACTIVE)
sub_statusJSONOptionalFiner state within the status, when there is one
sub_status (anyOf 1)stringAlternativeFiner state within the status, when there is one
Known values: PENDING_INVITE, INVITED, ONBOARDING, AWAITING_CLIENT_REVIEW, CANCELLED, REJECTED
sub_status (anyOf 2)nullAlternative
subject_to_overduebooleanOptionalIndicates 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

FieldTypePresenceDescription and constraints
$objectRootStepper action information
completed_atJSONOptional
completed_at (anyOf 1)stringAlternativeCompletion timestamp of the stepper action
Format: date-time
completed_at (anyOf 2)nullAlternativeCompletion timestamp of the stepper action
Format: date-time
dataJSONOptional
data (anyOf 1)ModelAlternativeExpand Get onboarding details by onboarding tracker ID — 200 response body — data stepper item data
data (anyOf 2)nullAlternative
typestringOptionalType 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

FieldTypePresenceDescription and constraints
$objectRootOnly when the worker has an avatar
pic_urlstringOptionalThe avatar URL of the worker, the same value as `worker.avatar_url`

List onboarding employees — 200 response body — data item progress

FieldTypePresenceDescription and constraints
$objectRootThe progress state of the onboarding
is_action_required_from_clientJSONOptional
is_action_required_from_client (anyOf 1)booleanAlternativeWhether action is required from the client
is_action_required_from_client (anyOf 2)nullAlternativeWhether action is required from the client
lifecycle_statusstringOptionalLifecycle 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_dateModelOptionalExpand List onboarding employees — 200 response body — data item progress onboarding due date
Due date for onboarding
people_list_statusstringOptionalStatus of the people list
reference_dateModelOptionalExpand List onboarding employees — 200 response body — data item progress reference date
The reference date determining the onboarding status
reference_date_timezoneJSONOptional
reference_date_timezone (anyOf 1)stringAlternativeTimezone of the reference date
reference_date_timezone (anyOf 2)nullAlternativeTimezone of the reference date
reference_date_typeJSONOptional
reference_date_type (anyOf 1)stringAlternativeType of the reference date (e.g., EFFECTIVE_DATE)
reference_date_type (anyOf 2)nullAlternativeType of the reference date (e.g., EFFECTIVE_DATE)
statusstringOptionalCurrent status of the onboarding
stepsJSONOptionalOnboarding 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)ModelAlternativeExpand List onboarding employees — 200 response body — data item progress steps completed, in progress, in review, not started, overdue, total
steps (anyOf 2)nullAlternative
sub_statusJSONOptionalFiner state within the status, when there is one
sub_status (anyOf 1)stringAlternativeFiner state within the status, when there is one
Known values: PENDING_INVITE, INVITED, ONBOARDING, AWAITING_CLIENT_REVIEW, CANCELLED, REJECTED
sub_status (anyOf 2)nullAlternative
subject_to_overduebooleanOptionalWhether the onboarding is subject to overdue
waiting_onJSONOptionalThe 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)stringAlternativeThe 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)nullAlternative

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

FieldTypePresenceDescription and constraints
$JSONRootDue date for onboarding
$ (anyOf 1)stringAlternativeFormat: date
$ (anyOf 2)stringAlternativeFormat: date-time

List onboarding employees — 200 response body — data item progress reference date

FieldTypePresenceDescription and constraints
$JSONRootThe reference date determining the onboarding status
$ (anyOf 1)stringAlternativeFormat: date
$ (anyOf 2)stringAlternativeFormat: date-time
$ (anyOf 3)stringAlternativeMaximum length: 0

List onboarding employees — 200 response body — data item progress steps completed, in progress, in review, not started, overdue, total

FieldTypePresenceDescription and constraints
$objectRootOnboarding 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
completedJSONOptional
completed (anyOf 1)integerAlternativeCompleted steps
completed (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
in_progressJSONOptional
in_progress (anyOf 1)integerAlternativeSteps started but not completed
in_progress (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
in_reviewJSONOptional
in_review (anyOf 1)integerAlternativeSteps waiting for a review
in_review (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
not_startedJSONOptional
not_started (anyOf 1)integerAlternativeSteps not started yet
not_started (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
overdueJSONOptional
overdue (anyOf 1)integerAlternativeSteps past their due date and not completed
overdue (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
totalJSONOptional
total (anyOf 1)integerAlternativeNumber of checklist steps
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List onboarding employees — 200 response body — data item worker

FieldTypePresenceDescription and constraints
$objectRootThe worker being onboarded
avatar_urlJSONOptional
avatar_url (anyOf 1)stringAlternativeThe avatar URL of the worker
avatar_url (anyOf 2)nullAlternativeThe avatar URL of the worker
idJSONOptional
id (anyOf 1)stringAlternativeThe HRIS profile identifier of the worker. Null for a draft quote
id (anyOf 2)nullAlternativeThe HRIS profile identifier of the worker. Null for a draft quote
is_contractor_of_recordbooleanOptionalWhether a contractor is engaged through Contractor of Record
is_entity_contractorbooleanOptionalWhether a contractor is engaged through a company rather than as an individual
job_titleJSONOptional
job_title (anyOf 1)stringAlternativeThe job title on the contract
job_title (anyOf 2)nullAlternativeThe job title on the contract
nameJSONOptional
name (anyOf 1)stringAlternativeThe full name of the worker
name (anyOf 2)nullAlternativeThe full name of the worker

List onboarding employees — 200 response body — page

FieldTypePresenceDescription and constraints
$objectRoot
cursorJSONOptional
cursor (anyOf 1)stringAlternativeCursor for pagination
cursor (anyOf 2)nullAlternativeCursor for pagination
total_rowsJSONOptional
total_rows (anyOf 1)integerAlternativeTotal number of onboardings matching the filters. Stays the same across every page of a cursor walk.
total_rows (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.