Skip to content

Deel: Add external Id — 200 response body — client Client details associated with the contract

Add external Id: 200 response body, field client / Client details associated with the contract. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Add external Id — 200 response body — client Client details associated with the contract

FieldTypePresenceDescription and constraints
$objectRootClient details associated with the contract.
emailJSONOptional
email (anyOf 1)stringAlternativeUser’s email address. It can be an empty string when no email has been provided for the worker. This can happen for draft contracts or workers with incomplete onboarding.
email (anyOf 2)nullAlternativeUser’s email address. It can be an empty string when no email has been provided for the worker. This can happen for draft contracts or workers with incomplete onboarding.
full_namestringOptionalFull name of the client.
idstringOptionalUnique identifier of this resource.
legal_entityJSONOptionalLegal entity details of the client.
legal_entity (anyOf 1)ModelAlternativeExpand Add external Id — 200 response body — client Client details associated with the contract legal entity Legal entity details of the client
legal_entity (anyOf 2)nullAlternative
teamModelRequired within parentExpand Add external Id — 200 response body — client Client details associated with the contract team
Team information for the client organization.

Referenced models: Add external Id — 200 response body — client Client details associated with the contract legal entity Legal entity details of the client, Add external Id — 200 response body — client Client details associated with the contract team

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.