Deel subpackage_contracts API
The subpackage_contracts API from Deel — 10 operation(s) for subpackage_contracts.
Deel subpackage_contracts API is one of 91 APIs that Deel publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.
This API exposes 12 operations across 10 paths, and defines 239 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api.letsdeel.com/rest/v2, https://api-staging.letsdeel.com/rest/v2.
12 operations
10 paths
239 schemas
5 GET2 PATCH5 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Deel subpackage_contracts API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (deelToken).
It accepts HTTP bearer tokens (oauth2).
deelToken— Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authenticatio…oauth2— Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/
Paths & Operations 12
Across 10 paths, the API surfaces 12 operations — 5 GET, 2 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.
subpackage_contracts 12
PATCH
/contracts/{contract_id}
Add external Id
GET
/contracts/{contract_id}
Retrieve a single contract
POST
/contracts
Create a new contract
GET
/contracts
List of contracts
PATCH
/equity/exercise/{public_id}
Approve an equity exercise
POST
/equity/exercise
Create a request to exercise equity.
GET
/contracts/{contract_id}/equity_withholding_estimate
Get an estimate of withholding amount given an equity event.
POST
/workers/contracts/{contract_id}/reject
Reject contract
GET
/workers/contracts/{contract_id}/pdf
Retrieve contract PDF download link
GET
/contract-templates
Retrieve contract templates
POST
/workers/amendments/{amendment_id}/sign
Sign amendment
POST
/workers/contracts/{contract_id}/signatures
Sign worker contract
Schemas 239
The contract defines 239 schemas that model the data the API accepts and returns. The most detailed are ContractsContractIdGetResponsesContentApplicationJsonSchemaData (31 properties), contracts_updateICContract_Response_200 (29 properties), ContractsPostResponsesContentApplicationJsonSchemaDataQuote (24 properties), ContractsPostResponsesContentApplicationJsonSchemaData (24 properties). Each schema is shown below with its type and property counts.
CreateARequestToExerciseEquity-v2026-01-01RequestForbiddenError
object
1 property
1 required
Contracts_approveAnEquityExercise-v2026-01-01_Response_200
object
5 properties
5 required
ContractsPostResponsesContentApplicationJsonSchemaDataType
string
Type of a contract
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientTeamId
Unique identifier of this resource.
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsFrequency
string
Scale of the invoice cycle.
CreateARequestToExerciseEquity-v2026-01-01RequestNotFoundError
object
1 property
1 required
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataSeniority
object
Seniority describes level of expertise at a job e.g. junior.
3 properties
ContractsContractIdPatchResponsesContentApplicationJsonSchemaQuoteBenefitsItems
object
7 properties
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Type
string
Type of contract
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClient
object
Client details associated with the contract.
5 properties
1 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1SeniorityId
Unique identifier of this resource.
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientLegalEntity
object
Choose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization.
1 property
1 required
RejectContractRequestInternalServerError
object
1 property
ContractsPostResponsesContentApplicationJsonSchemaDataClientLegalEntityType
string
Type of a legal entity
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClientTeamId
Unique identifier of this resource.
ListOfContractsRequestBadRequestError
object
2 properties
1 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientLegalEntityId
Unique identifier of this resource.
GetContractEquityWithholdingAmountRequestNotFoundError
object
SignWorkerContractRequestInternalServerError
object
1 property
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Meta
object
Additional custom info about a contract
2 properties
1 required
CreateARequestToExerciseEquity-v2026-01-01RequestInternalServerError
object
1 property
1 required
ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleEmploymentType
string
Type of employment arrangement
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsCycleEndType
string
Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31.
ContractsContractIdPatchResponsesContentApplicationJsonSchemaEmploymentType
string
Type of employment.
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleWorkerTypesItems
string
ContractsContractIdPatchResponsesContentApplicationJsonSchemaClientTeamId
Unique identifier of this resource.
ContractsGetResponsesContentApplicationJsonSchemaDataItems
object
17 properties
11 required
GetContractEquityWithholdingAmountRequestBadRequestError
object
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientLegalEntityId
Unique identifier of this resource.
ApproveAnEquityExercise-v2026-01-01RequestForbiddenError
object
1 property
1 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Type
string
Type of contract
ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkSchedule
object
Defines a work schedule including working days, hours, and employment details
7 properties
6 required
RejectContractRequestBadRequestError
object
1 property
ContractsGetParametersCurrencies
ContractsPostRequestBodyContentApplicationJsonSchemaData2
object
Details of contract to create
20 properties
6 required
ContractsContractIdPatchResponsesContentApplicationJsonSchemaCompensationDetails
object
Compensation and payment configuration for the contract.
11 properties
ContractsContractIdPatchResponsesContentApplicationJsonSchemaContractTemplate
object
Contract template details.
2 properties
ApproveAnEquityExercise-v2026-01-01RequestNotFoundError
object
1 property
1 required
ContractsGetResponsesContentApplicationJsonSchemaDataItemsType
string
Type of a contract.
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsPaymentDueType
string
Type of payment due. If the payment is due on the last day of month, enter 'WITHINMONTH'. If the payment is due some days after the end of the month, enter 'AF…
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataEmploymentType
string
Type of employment.
EquityExercisePostResponsesContentApplicationJsonSchemaData
object
4 properties
4 required
ContractsPostResponsesContentApplicationJsonSchemaDataWhoReports
string
Flag to indicate who is supposed to provide regular reports
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Type
string
Type of contract
ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleDaysItemsDay
string
Day of the week
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCostCentersItems
object
3 properties
WorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Meta
object
Additional custom info about a contract
2 properties
1 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientLegalEntityId
Unique identifier of this resource.
ContractTemplatesGetResponsesContentApplicationJsonSchemaDataItemsId
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetailsFrequency
string
Scale of the invoice cycle.
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Meta
object
Additional custom info about a contract
2 properties
1 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientTeam
object
Choose the Deel team for this contract. Use teams endpoint to retrieve a list of teams in your organization.
1 property
1 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetails
object
12 properties
8 required
WorkersAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
contracts_getContract_Response_200
object
1 property
1 required
ContractsGetParametersStatusesSchemaItems
string
Status of a contract in Deel workflow.
ContractsContractIdPatchResponsesContentApplicationJsonSchemaClientLegalEntity
object
Legal entity details of the client.
7 properties
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsPaymentDueType
string
Type of payment due. If the payment is due on the last day of month, enter 'WITHINMONTH'. If the payment is due some days after the end of the month, enter 'AF…
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Client
object
Client details for the contract, including the legal entity and team.
2 properties
2 required
ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBreakdownCosts
object
Cost breakdown for the quote, grouped by billing cadence (e.g., monthly).
1 property
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataSignatures
object
Signature information for the contract parties.
5 properties
ContractsPostResponsesContentApplicationJsonSchemaDataInvitations
object
List of signature invitations sent for this contract.
2 properties
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CompensationDetailsCycleEndType
string
Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31.
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsFrequency
string
Scale of the invoice cycle.
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsScale
string
Defines the scale at which the amount is paid. For example, enter 'hourly' to define the amount per hour. This field can be excluded when creating a Pay-as-you…
ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorker
object
Worker details associated with the contract.
10 properties
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Client
object
Client details for the contract, including the legal entity and team.
2 properties
2 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Seniority
object
Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels.
1 property
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Worker
object
Worker properties
4 properties
2 required
Contracts_getContractEquityWithholdingAmount_Response_200
object
1 property
contracts_updateICContract_Response_200
object
29 properties
14 required
ContractsContractIdEquityWithholdingEstimateGetResponsesContentApplicationJsonSchemaData
object
8 properties
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkSchedule
object
Defines a work schedule including working days, hours, and employment details
7 properties
6 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientTeamId
Unique identifier of this resource.
ContractsPostResponsesContentApplicationJsonSchemaDataTerminationDate
Contract termination date. When present, it is a date-time string in ISO-8601 format.
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsScale
string
Defines the scale at which the amount is paid. For example, enter 'hourly' to define the amount per hour. This field can be excluded when creating a Pay-as-you…
ContractsContractIdPatchResponsesContentApplicationJsonSchemaClientTeam
object
Team information for the client organization.
2 properties
2 required
WorkersContractsContractIdPdfGetResponsesContentApplicationJsonSchemaData
object
1 property
1 required
ContractsContractIdPatchResponsesContentApplicationJsonSchemaEmploymentDetails
object
Employment-related details for the contract.
5 properties
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1JobTitleId
Unique identifier of this resource.
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetailsPaymentDueType
string
Type of payment due. If the payment is due on the last day of month, enter 'WITHINMONTH'. If the payment is due some days after the end of the month, enter 'AF…
ContractsPostRequestBodyContentApplicationJsonSchemaData
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetails
object
Compensation and invoicing configuration for the contract.
11 properties
6 required
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleEmploymentType
string
Type of employment arrangement
WorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaData
object
4 properties
4 required
ContractsPostResponsesContentApplicationJsonSchemaDataQuote
object
EOR quote approved by Deel
24 properties
ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBenefitsItems
object
7 properties
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Meta
object
Additional custom info about a contract
2 properties
1 required
ContractsContractIdPatchRequestBodyContentApplicationJsonSchemaData
object
1 property
1 required
CreateARequestToExerciseEquity-v2026-01-01RequestUnauthorizedError
object
1 property
1 required
ContractsContractIdPatchResponsesContentApplicationJsonSchemaQuote
object
EOR quote approved by Deel.
2 properties
Contracts_createARequestToExerciseEquity-v2026-01-01_Response_201
object
1 property
1 required
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataType
string
Type of a contract.
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3JobTitle
object
Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint.
2 properties
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientLegalEntityId
Unique identifier of this resource.
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientTeam
object
Choose the Deel team for this contract. Use teams endpoint to retrieve a list of teams in your organization.
1 property
1 required
ContractsGetResponsesContentApplicationJsonSchemaDataItemsWorker
object
Worker information associated with the contract.
5 properties
1 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CompensationDetails
object
Compensation and invoicing configuration for the contract.
11 properties
6 required
ApiErrorContainer
object
2 properties
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataContractTemplate
object
Contract template details.
2 properties
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2JobTitleId
Unique identifier of this resource.
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Worker
object
Worker properties
4 properties
2 required
contracts_getContracts_Response_200
object
2 properties
2 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3WhoReports
string
Flag to indicate who is supposed to provide regular reports
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientLegalEntity
object
Choose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization.
1 property
1 required
WorkersAmendmentsAmendmentIdSignPostRequestBodyContentApplicationJsonSchemaData
object
1 property
1 required
ContractsGetResponsesContentApplicationJsonSchemaPage
object
Pagination information for the response.
2 properties
2 required
ContractsContractIdPatchResponsesContentApplicationJsonSchemaSignatures
object
Signature information for the contract parties.
5 properties
ContractsGetResponsesContentApplicationJsonSchemaDataItemsClientTeam
object
Team information for the client.
2 properties
2 required
Contracts_signWorkerContract_Response_201
object
1 property
1 required
ContractsPostResponsesContentApplicationJsonSchemaDataWorker
object
Worker details associated with the contract.
12 properties
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2WhoReports
string
Flag to indicate who is supposed to provide regular reports
ContractsPostResponsesContentApplicationJsonSchemaDataCompensationDetails
object
Compensation configuration and payment schedule details for the contract.
9 properties
9 required
ApiErrorRequest
object
7 properties
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Seniority
object
Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels.
1 property
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientTeamId
Unique identifier of this resource.
ContractsContractIdGetResponsesContentApplicationJsonSchemaErrorsItems
object
1 property
1 required
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCompensationDetails
object
Compensation and payment configuration for the contract.
11 properties
ContractsContractIdGetResponsesContentApplicationJsonSchemaData
object
31 properties
14 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientLegalEntity
object
Choose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization.
1 property
1 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2JobTitle
object
Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint.
2 properties
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1JobTitle
object
Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint.
2 properties
ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleWorkerTypesItems
string
Contracts_retrieveContractPdfDownloadLink_Response_200
object
1 property
1 required
ContractsPostResponsesContentApplicationJsonSchemaDataCustomFieldsItems
object
Customized attributes on contracts (Employee ID, Project code, etc).
2 properties
WorkersContractsContractIdRejectPostResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
ContractsPostResponsesContentApplicationJsonSchemaDataSeniority
object
Seniority describes level of expertise at a job e.g. junior
3 properties
2 required
ContractsGetResponsesContentApplicationJsonSchemaDataItemsStatus
string
Status of a contract in Deel workflow.
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Seniority
object
Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels.
1 property
ContractsGetParametersTypesSchemaItems
string
Type of a contract.
ContractsContractIdPatchResponsesContentApplicationJsonSchemaStatus
string
Status of a contract in Deel workflow.
WorkersContractsContractIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataEmploymentDetails
object
Employment-related details for the contract.
5 properties
Contracts_signAmendment_Response_201
object
1 property
1 required
ContractTemplatesGetResponsesContentApplicationJsonSchemaDataItems
object
2 properties
2 required
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCompensationDetailsCycleEndType
string
Cycle end type
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataQuote
object
EOR quote approved by Deel.
2 properties
WorkersContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaData
object
1 property
1 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientTeam
object
Choose the Deel team for this contract. Use teams endpoint to retrieve a list of teams in your organization.
1 property
1 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CompensationDetailsPaymentDueType
string
Type of payment due. If the payment is due on the last day of month, enter 'WITHINMONTH'. If the payment is due some days after the end of the month, enter 'AF…
ContractsPostRequestBodyContentApplicationJsonSchemaData1
object
Details of contract to create
20 properties
7 required
ApproveAnEquityExercise-v2026-01-01RequestTooManyRequestsError
object
1 property
1 required
ContractsContractIdEquityWithholdingEstimateGetResponsesContentApplicationJsonSchemaDataBreakdownItems
object
3 properties
ContractsContractIdPatchResponsesContentApplicationJsonSchemaCompensationDetailsCycleEndType
string
Cycle end type
ContractsPostResponsesContentApplicationJsonSchemaDataStatus
string
Status of a contract in Deel workflow
ApiError
object
2 properties
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetails
object
12 properties
8 required
ContractsPostRequestBodyContentApplicationJsonSchemaData0
object
Details of contract to create
20 properties
7 required
ContractsPostResponsesContentApplicationJsonSchemaDataSignatures
object
List of signatures recorded for this contract.
5 properties
5 required
ContractsContractIdPatchResponsesContentApplicationJsonSchemaClient
object
Client details associated with the contract.
5 properties
1 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetailsCycleEndType
string
Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31.
WorkersAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaRequest
object
7 properties
ContractsGetResponsesContentApplicationJsonSchemaDataItemsCostCentersItems
object
Cost center object.
3 properties
contracts_createICContract_Response_201
object
1 property
1 required
CreateARequestToExerciseEquity-v2026-01-01RequestUnprocessableEntityError
object
1 property
1 required
ContractsGetParametersExpand
string
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Client
object
Client details for the contract, including the legal entity and team.
2 properties
2 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0SeniorityId
Unique identifier of this resource.
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientLegalEntity
object
Choose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization.
1 property
1 required
ContractsGetResponsesContentApplicationJsonSchemaRequest
object
Error request details
2 properties
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataStatus
string
Status of a contract in Deel workflow.
ContractsGetParametersOrderDirection
string
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClientTeam
object
Team information for the client organization.
2 properties
2 required
ContractsContractIdPatchResponsesContentApplicationJsonSchemaErrorsItems
object
1 property
1 required
ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkerAlternateEmailItems
object
2 properties
ContractsContractIdPatchResponsesContentApplicationJsonSchemaSeniority
object
Seniority describes level of expertise at a job e.g. junior.
3 properties
ContractsGetParametersSortBy
string
SignAmendmentRequestBadRequestError
object
2 properties
CreateARequestToExerciseEquity-v2026-01-01RequestTooManyRequestsError
object
1 property
1 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientTeam
object
Choose the Deel team for this contract. Use teams endpoint to retrieve a list of teams in your organization.
1 property
1 required
ApproveAnEquityExercise-v2026-01-01RequestInternalServerError
object
1 property
1 required
RetrieveASingleContract-v2026-01-01RequestNotFoundError
object
2 properties
1 required
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkerAlternateEmailItems
object
2 properties
ContractsPostResponsesContentApplicationJsonSchemaDataTerminationDate1
string
EquityExercisePublicIdPatchResponsesContentApplicationJsonSchemaErrorsItems
object
1 property
1 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Worker
object
Worker properties
4 properties
2 required
ContractsGetResponsesContentApplicationJsonSchemaDataItemsWorkerAlternateEmailItems
object
Alternate email address object.
2 properties
ContractsPostResponsesContentApplicationJsonSchemaDataWorkerAlternateEmailItems
object
2 properties
2 required
ContractsPostResponsesContentApplicationJsonSchemaDataWorkerLegalEntityType
string
Type of a legal entity
ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleDaysItems
object
Defines working hours for a specific day of the week
4 properties
4 required
CreateANewContract-v2026-01-01RequestBadRequestError
object
2 properties
1 required
ContractsContractIdPatchResponsesContentApplicationJsonSchemaCostCentersItems
object
3 properties
ContractsGetResponsesContentApplicationJsonSchemaDataItemsWhoReports
string
Indicates who is responsible for providing regular reports.
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Seniority
object
Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels.
1 property
ContractsGetResponsesContentApplicationJsonSchemaDataItemsInvitations
object
Details of invitations sent for signing the contract.
2 properties
SignWorkerContractRequestBadRequestError
object
1 property
ContractsContractIdPatchResponsesContentApplicationJsonSchemaInvitations
object
Invitation email addresses for signing the contract.
2 properties
ContractsPostResponsesContentApplicationJsonSchemaDataClientLegalEntity
object
Legal entity information for the client organization.
7 properties
7 required
ContractsPostResponsesContentApplicationJsonSchemaDataClientTeam
object
Team information for the client organization.
2 properties
2 required
ContractsContractIdPatchResponsesContentApplicationJsonSchemaRequest
object
Error request details
2 properties
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2SeniorityId
Unique identifier of this resource.
ContractsContractIdGetParametersExpand
string
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1WhoReports
string
Flag to indicate who is supposed to provide regular reports
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCustomFieldsItems
object
Customized attributes on contracts (Employee ID, Project code, etc).
3 properties
ContractsPostResponsesContentApplicationJsonSchemaErrorsItems
object
1 property
1 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3JobTitleId
Unique identifier of this resource.
Contracts_getContractTemplates_Response_200
object
1 property
RetrieveContractPdfDownloadLinkRequestInternalServerError
object
1 property
ContractsContractIdGetResponsesContentApplicationJsonSchemaRequest
object
Error request details
2 properties
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataInvitations
object
Invitation email addresses for signing the contract.
2 properties
ContractsGetResponsesContentApplicationJsonSchemaErrorsItems
object
1 property
1 required
WorkersAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaData
object
2 properties
2 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0JobTitle
object
Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint.
2 properties
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataQuoteBenefitsItems
object
7 properties
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleDaysItemsDay
string
Day of the week
ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBreakdownCostsMonthlyCostsItems
object
4 properties
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorker
object
Worker details associated with the contract.
10 properties
ContractsPostResponsesContentApplicationJsonSchemaDataEmploymentDetails
object
Employment-related details for the contract, when applicable.
7 properties
5 required
ContractsPostResponsesContentApplicationJsonSchemaDataWorkerLegalEntity
object
Worker legal entity information, if applicable.
3 properties
3 required
ContractsGetResponsesContentApplicationJsonSchemaDataItemsSignatures
object
Signature information for the contract.
3 properties
3 required
EquityExercisePostResponsesContentApplicationJsonSchemaErrorsItems
object
1 property
1 required
Contracts_rejectContract_Response_204
object
Empty response body
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CompensationDetailsFrequency
string
Scale of the invoice cycle.
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0JobTitleId
Unique identifier of this resource.
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3SeniorityId
Unique identifier of this resource.
ContractsPostResponsesContentApplicationJsonSchemaRequest
object
Error request details
2 properties
ContractsPostResponsesContentApplicationJsonSchemaData
object
24 properties
17 required
ApproveAnEquityExercise-v2026-01-01RequestUnauthorizedError
object
1 property
1 required
ContractsContractIdPatchResponsesContentApplicationJsonSchemaCustomFieldsItems
object
Customized attributes on contracts (Employee ID, Project code, etc).
2 properties
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientTeamId
Unique identifier of this resource.
ContractsGetResponsesContentApplicationJsonSchemaDataItemsClient
object
Client information associated with the contract.
1 property
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0WhoReports
string
Flag to indicate who is supposed to provide regular reports
ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkerDateOfBirth2
string
Empty string for unknown/unset values.
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClientLegalEntity
object
Legal entity details of the client.
7 properties
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkerDateOfBirth
AddExternalIdRequestNotFoundError
object
2 properties
1 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Type
string
Type of contract
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsCycleEndType
string
Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31.
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Client
object
Client details for the contract, including the legal entity and team.
2 properties
2 required
ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBreakdownCostsMonthly
object
Monthly cost breakdown for the quote.
3 properties
ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkerDateOfBirth
Date of birth of the worker. Supports full date-time, date-only, or an empty string.
RetrieveContractPdfDownloadLinkRequestBadRequestError
object
1 property
ContractsPostRequestBodyContentApplicationJsonSchemaData3
object
Details of contract to create
20 properties
7 required
ContractsContractIdPatchResponsesContentApplicationJsonSchemaType
string
Type of a contract.
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleDaysItems
object
Defines working hours for a specific day of the week
4 properties
4 required
ContractsPostResponsesContentApplicationJsonSchemaDataClient
object
Client details associated with the contract.
5 properties
2 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Worker
object
Worker properties
4 properties
2 required
CreateARequestToExerciseEquity-v2026-01-01RequestBadRequestError
object
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Deel 12
Other APIs Deel publishes across the network.
Deel Default API
Deel subpackage_accounting API
Deel subpackage_adjustments API
Deel subpackage_assets API
Deel subpackage_ats API
Deel subpackage_candidates API
Deel subpackage_consent API
Deel subpackage_contractorAmendments API
Deel subpackage_contractorHiring API
Deel subpackage_costCalculator API
Deel subpackage_costCenters API
Deel subpackage_customFieldsContracts API
Where this information came from
This is an independent, third-party profile of Deel subpackage_contracts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.