Skip to content

Deel: List onboarding employees — 200 response body — data item overview actions, app experience, banner, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary contract

List onboarding employees: 200 response body, field data / item / overview / actions, app_experience, banner, checklist, contract, contracts, hiring_type, hris_profile, profile, progress, stepper, summary / contract. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: List onboarding employees — 200 response body — data item overview actions, app experience, banner, 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, 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, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary contract first early invoice amount, currency, description, due date, id, paid at, status

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.