Skip to content

Deel: Retrieve a single contract — 200 response body — data

Retrieve a single contract: 200 response body, field data. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Retrieve a single contract — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
clientJSONRequired within parentClient details associated with the contract.
client (anyOf 1)ModelAlternativeExpand Retrieve a single contract — 200 response body — data client Client details associated with the contract
client (anyOf 2)nullAlternative
compensation_detailsModelOptionalExpand Add external Id — 200 response body — compensation details
Compensation and payment configuration for the contract.
contract_templateJSONOptionalContract template details.
contract_template (anyOf 1)ModelAlternativeExpand Add external Id — 200 response body — contract template Contract template details
contract_template (anyOf 2)nullAlternative
cost_centersarrayOptionalList of cost centers associated with the contract.
cost_centers[]ModelEach itemExpand Add external Id — 200 response body — cost centers item
created_atstringRequired within parentDate and time when the contract was created.
Format: date-time
custom_fieldsJSONOptional
custom_fields (anyOf 1)arrayAlternativeList of custom fields attached to the contract.
custom_fields (anyOf 1)[]ModelEach itemExpand Retrieve a single contract — 200 response body — data custom fields List of custom fields attached to the contract item
custom_fields (anyOf 2)nullAlternativeList of custom fields attached to the contract.
custom_fields (anyOf 2)[]ModelEach itemExpand Retrieve a single contract — 200 response body — data custom fields List of custom fields attached to the contract item
divisionJSONOptional
division (anyOf 1)stringAlternativeDivision the worker belongs to, from the active job information of a Global Payroll contract. Null for other contract types or when no division is set.
division (anyOf 2)nullAlternativeDivision the worker belongs to, from the active job information of a Global Payroll contract. Null for other contract types or when no division is set.
employment_detailsModelOptionalExpand Retrieve a single contract — 200 response body — data employment details
Employment-related details for the contract.
employment_typeJSONOptionalType of employment.
employment_type (anyOf 1)stringAlternativeType of employment.
Known values: FULL_TIME, PART_TIME
employment_type (anyOf 2)nullAlternative
external_idJSONOptional
external_id (anyOf 1)stringAlternativeExternal identifier of the contract.
external_id (anyOf 2)nullAlternativeExternal identifier of the contract.
fte_percentageJSONOptional
fte_percentage (anyOf 1)JSONAlternative
fte_percentage (anyOf 1) (anyOf 1)numberAlternativeFull time percentage
Format: double
fte_percentage (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fte_percentage (anyOf 2)nullAlternativeFull time percentage
Format: double
idstringRequired within parentUnique identifier for the contract.
Minimum length: 1
invitationsModelRequired within parentExpand Add external Id — 200 response body — invitations
Invitation email addresses for signing the contract.
is_archivedJSONRequired within parent
is_archived (anyOf 1)booleanAlternativeFlag to indicate if the contract is archived.
is_archived (anyOf 2)nullAlternativeFlag to indicate if the contract is archived.
job_titlestringOptionalJob title associated with the contract.
locationJSONOptional
location (anyOf 1)stringAlternativeLocation name associated with the contract.
location (anyOf 2)nullAlternativeLocation name associated with the contract.
notice_periodJSONOptional
notice_period (anyOf 1)JSONAlternative
notice_period (anyOf 1) (anyOf 1)numberAlternativeNotice period in days.
Format: double
notice_period (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
notice_period (anyOf 2)nullAlternativeNotice period in days.
Format: double
platform_payment_typestringOptionalWhether the contract is paid through Deel (`STANDARD`) or outside Deel (`OFF_PLATFORM`). Applies to IC contracts only.
Known values: STANDARD, OFF_PLATFORM
product_areaJSONOptional
product_area (anyOf 1)JSONAlternative
product_area (anyOf 1) (anyOf 1)numberAlternativeProduct area code associated with the contract.
Format: double
product_area (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
product_area (anyOf 2)nullAlternativeProduct area code associated with the contract.
Format: double
quoteModelOptionalExpand Add external Id — 200 response body — quote
EOR quote approved by Deel.
scope_of_workJSONOptional
scope_of_work (anyOf 1)stringAlternativeScope of work of the contract.
scope_of_work (anyOf 2)nullAlternativeScope of work of the contract.
seniorityJSONOptionalSeniority describes level of expertise at a job e.g. junior.
seniority (anyOf 1)ModelAlternativeExpand Add external Id — 200 response body — seniority id, level, name
seniority (anyOf 2)nullAlternative
signaturesModelRequired within parentExpand Add external Id — 200 response body — signatures
Signature information for the contract parties.
special_clauseJSONRequired within parent
special_clause (anyOf 1)stringAlternativeSpecial clause of the contract.
special_clause (anyOf 2)nullAlternativeSpecial clause of the contract.
start_datestringRequired within parentDate and time when the contract starts.
Format: date-time
statusModelRequired within parentExpand Add external Id — 200 response body — status
Status of a contract in Deel workflow.
termination_dateJSONRequired within parent
termination_date (anyOf 1)stringAlternativeDate and time when the contract ends.
termination_date (anyOf 2)nullAlternativeDate and time when the contract ends.
titlestringRequired within parentTitle of the contract.
Minimum length: 1
typestringRequired within parentType of a contract.
Known values: ongoing_time_based, milestones, time_based, pay_as_you_go_time_based, commission, payg_milestones, payg_tasks, contractor_outside_deel, eor, unknown, employee, global_payroll, shield_msa, hris_direct_employee, peo
updated_atstringRequired within parentDate and time when the contract was updated.
Format: date-time
who_reportsstringOptionalWho reports the hours.
work_scheduleJSONOptionalDefines a work schedule including working days, hours, and employment details
work_schedule (anyOf 1)ModelAlternativeExpand Retrieve a single contract — 200 response body — data work schedule country, days, effective from, employment type, name, work hours per week, work schedule type, worker types
work_schedule (anyOf 2)nullAlternative
work_statement_idJSONOptional
work_statement_id (anyOf 1)stringAlternativeThe unique identifier of the associated work statement.
work_statement_id (anyOf 2)nullAlternativeThe unique identifier of the associated work statement.
workerJSONRequired within parentWorker details associated with the contract.
worker (anyOf 1)ModelAlternativeExpand Retrieve a single contract — 200 response body — data worker Worker details associated with the contract
worker (anyOf 2)nullAlternative

Referenced models: Add external Id — 200 response body — contract template Contract template details, Retrieve a single contract — 200 response body — data client Client details associated with the contract, Add external Id — 200 response body — compensation details, Add external Id — 200 response body — cost centers item, Retrieve a single contract — 200 response body — data custom fields List of custom fields attached to the contract item, Retrieve a single contract — 200 response body — data employment details, Add external Id — 200 response body — invitations, Add external Id — 200 response body — quote, Add external Id — 200 response body — seniority id, level, name, Add external Id — 200 response body — signatures, Add external Id — 200 response body — status, Retrieve a single contract — 200 response body — data work schedule country, days, effective from, employment type, name, work hours per week, work schedule type, worker types, Retrieve a single contract — 200 response body — data worker Worker details associated with the contract

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.