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 profile Employee profile information

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 / profile / Employee profile information. 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 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

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.