Deel Subpackage Contracts API
The subpackage_contracts API from Deel — 10 operation(s) for subpackage_contracts.
Deel Subpackage Contracts API is one of 128 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.2.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.
Contracts_signAmendment_Response_201
object
1 property
1 required
CreateARequestToExerciseEquity-v2026-01-01RequestInternalServerError
object
1 property
1 required
ContractsContractIdEquityWithholdingEstimateGetResponsesContentApplicationJsonSchemaData
object
8 properties
ContractsGetResponsesContentApplicationJsonSchemaDataItemsWorker
object
Worker information associated with the contract.
5 properties
1 required
contracts_createICContract_Response_201
object
1 property
1 required
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCustomFieldsItems
object
Customized attributes on contracts (Employee ID, Project code, etc).
3 properties
ContractsPostResponsesContentApplicationJsonSchemaDataCustomFieldsItems
object
Customized attributes on contracts (Employee ID, Project code, etc).
2 properties
ContractsGetResponsesContentApplicationJsonSchemaDataItemsWhoReports
string
Indicates who is responsible for providing regular reports.
Contracts_createARequestToExerciseEquity-v2026-01-01_Response_201
object
1 property
1 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Worker
object
Worker properties
4 properties
2 required
ContractsPostRequestBodyContentApplicationJsonSchemaData0
object
Details of contract to create
20 properties
7 required
ContractsGetResponsesContentApplicationJsonSchemaDataItemsType
string
Type of a contract.
ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkerDateOfBirth2
string
Empty string for unknown/unset values.
ContractsPostResponsesContentApplicationJsonSchemaDataTerminationDate1
string
ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkerDateOfBirth
Date of birth of the worker. Supports full date-time, date-only, or an empty string.
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Meta
object
Additional custom info about a contract
2 properties
1 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Seniority
object
Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels.
1 property
ContractsGetResponsesContentApplicationJsonSchemaErrorsItems
object
1 property
1 required
ContractsGetParametersOrderDirection
string
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientLegalEntityId
Unique identifier of this resource.
ContractsContractIdPatchResponsesContentApplicationJsonSchemaCustomFieldsItems
object
Customized attributes on contracts (Employee ID, Project code, etc).
2 properties
ContractsPostResponsesContentApplicationJsonSchemaDataStatus
string
Status of a contract in Deel workflow
ContractsPostResponsesContentApplicationJsonSchemaDataEmploymentDetails
object
Employment-related details for the contract, when applicable.
7 properties
5 required
Contracts_getContractEquityWithholdingAmount_Response_200
object
1 property
WorkersAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
ContractsContractIdPatchResponsesContentApplicationJsonSchemaSignatures
object
Signature information for the contract parties.
5 properties
ContractsPostResponsesContentApplicationJsonSchemaErrorsItems
object
1 property
1 required
ContractsContractIdPatchResponsesContentApplicationJsonSchemaRequest
object
Error request details
2 properties
ContractsContractIdPatchResponsesContentApplicationJsonSchemaSeniority
object
Seniority describes level of expertise at a job e.g. junior.
3 properties
ContractsPostResponsesContentApplicationJsonSchemaDataWhoReports
string
Flag to indicate who is supposed to provide regular reports
ContractsContractIdPatchResponsesContentApplicationJsonSchemaType
string
Type of a contract.
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClientLegalEntity
object
Legal entity details of the client.
7 properties
RejectContractRequestInternalServerError
object
1 property
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Worker
object
Worker properties
4 properties
2 required
ContractsContractIdPatchResponsesContentApplicationJsonSchemaErrorsItems
object
1 property
1 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3WhoReports
string
Flag to indicate who is supposed to provide regular reports
WorkersAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaRequest
object
7 properties
ContractsPostResponsesContentApplicationJsonSchemaDataWorkerLegalEntity
object
Worker legal entity information, if applicable.
3 properties
3 required
CreateARequestToExerciseEquity-v2026-01-01RequestUnauthorizedError
object
1 property
1 required
ContractsGetParametersSortBy
string
ContractsContractIdPatchRequestBodyContentApplicationJsonSchemaData
object
1 property
1 required
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCostCentersItems
object
3 properties
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataType
string
Type of a contract.
ContractsPostResponsesContentApplicationJsonSchemaRequest
object
Error request details
2 properties
ContractsPostResponsesContentApplicationJsonSchemaDataQuote
object
EOR quote approved by Deel
24 properties
ContractsContractIdPatchResponsesContentApplicationJsonSchemaClient
object
Client details associated with the contract.
5 properties
1 required
ContractsContractIdPatchResponsesContentApplicationJsonSchemaClientLegalEntity
object
Legal entity details of the client.
7 properties
ContractsPostResponsesContentApplicationJsonSchemaDataType
string
Type of a contract
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Type
string
Type of contract
ContractTemplatesGetResponsesContentApplicationJsonSchemaDataItems
object
2 properties
2 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsFrequency
string
Scale of the invoice cycle.
ContractsGetParametersStatusesSchemaItems
string
Status of a contract in Deel workflow.
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
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleWorkerTypesItems
string
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataSignatures
object
Signature information for the contract parties.
5 properties
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleDaysItems
object
Defines working hours for a specific day of the week
4 properties
4 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0SeniorityId
Unique identifier of this resource.
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClient
object
Client details associated with the contract.
5 properties
1 required
ContractsPostResponsesContentApplicationJsonSchemaDataClient
object
Client details associated with the contract.
5 properties
2 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
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…
SignWorkerContractRequestBadRequestError
object
1 property
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientTeamId
Unique identifier of this resource.
ContractsGetResponsesContentApplicationJsonSchemaDataItemsClientTeam
object
Team information for the client.
2 properties
2 required
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorker
object
Worker details associated with the contract.
10 properties
RetrieveContractPdfDownloadLinkRequestInternalServerError
object
1 property
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataQuoteBenefitsItems
object
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…
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsFrequency
string
Scale of the invoice cycle.
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetails
object
12 properties
8 required
ContractsGetResponsesContentApplicationJsonSchemaDataItemsStatus
string
Status of a contract in Deel workflow.
WorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaData
object
4 properties
4 required
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
Contracts_rejectContract_Response_204
object
Empty response body
ContractsPostRequestBodyContentApplicationJsonSchemaData3
object
Details of contract to create
20 properties
7 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Type
string
Type of contract
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientTeamId
Unique identifier of this resource.
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0JobTitleId
Unique identifier of this resource.
ApproveAnEquityExercise-v2026-01-01RequestForbiddenError
object
1 property
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
ApproveAnEquityExercise-v2026-01-01RequestTooManyRequestsError
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
WorkersContractsContractIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
WorkersContractsContractIdPdfGetResponsesContentApplicationJsonSchemaData
object
1 property
1 required
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataContractTemplate
object
Contract template details.
2 properties
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientLegalEntityId
Unique identifier of this resource.
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCompensationDetailsCycleEndType
string
Cycle end type
CreateARequestToExerciseEquity-v2026-01-01RequestTooManyRequestsError
object
1 property
1 required
EquityExercisePostResponsesContentApplicationJsonSchemaErrorsItems
object
1 property
1 required
ContractsContractIdGetParametersExpand
string
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataInvitations
object
Invitation email addresses for signing the contract.
2 properties
contracts_updateICContract_Response_200
object
29 properties
14 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Type
string
Type of contract
AddExternalIdRequestNotFoundError
object
2 properties
1 required
ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkerAlternateEmailItems
object
2 properties
ContractsPostResponsesContentApplicationJsonSchemaData
object
24 properties
17 required
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
ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBreakdownCostsMonthly
object
Monthly cost breakdown for the quote.
3 properties
contracts_getContracts_Response_200
object
2 properties
2 required
WorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetailsCycleEndType
string
Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31.
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
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Client
object
Client details for the contract, including the legal entity and team.
2 properties
2 required
ContractsGetParametersTypesSchemaItems
string
Type of a contract.
ContractsPostRequestBodyContentApplicationJsonSchemaData
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsCycleEndType
string
Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31.
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Type
string
Type of contract
Contracts_getContractTemplates_Response_200
object
1 property
ContractsContractIdEquityWithholdingEstimateGetResponsesContentApplicationJsonSchemaDataBreakdownItems
object
3 properties
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkSchedule
object
Defines a work schedule including working days, hours, and employment details
7 properties
6 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientLegalEntityId
Unique identifier of this resource.
WorkersAmendmentsAmendmentIdSignPostRequestBodyContentApplicationJsonSchemaData
object
1 property
1 required
ApproveAnEquityExercise-v2026-01-01RequestInternalServerError
object
1 property
1 required
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClientTeamId
Unique identifier of this resource.
ContractsGetResponsesContentApplicationJsonSchemaDataItemsSignatures
object
Signature information for the contract.
3 properties
3 required
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkerDateOfBirth
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Worker
object
Worker properties
4 properties
2 required
ContractsContractIdPatchResponsesContentApplicationJsonSchemaCompensationDetailsCycleEndType
string
Cycle end type
ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBreakdownCostsMonthlyCostsItems
object
4 properties
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2WhoReports
string
Flag to indicate who is supposed to provide regular reports
WorkersAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaData
object
2 properties
2 required
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…
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Seniority
object
Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels.
1 property
ContractsContractIdGetResponsesContentApplicationJsonSchemaRequest
object
Error request details
2 properties
CreateANewContract-v2026-01-01RequestBadRequestError
object
2 properties
1 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Client
object
Client details for the contract, including the legal entity and team.
2 properties
2 required
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…
ContractsPostResponsesContentApplicationJsonSchemaDataTerminationDate
Contract termination date. When present, it is a date-time string in ISO-8601 format.
ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleWorkerTypesItems
string
WorkersContractsContractIdRejectPostResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
ContractsGetResponsesContentApplicationJsonSchemaDataItemsInvitations
object
Details of invitations sent for signing the contract.
2 properties
CreateARequestToExerciseEquity-v2026-01-01RequestUnprocessableEntityError
object
1 property
1 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientTeamId
Unique identifier of this resource.
EquityExercisePublicIdPatchResponsesContentApplicationJsonSchemaErrorsItems
object
1 property
1 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CompensationDetails
object
Compensation and invoicing configuration for the contract.
11 properties
6 required
ContractTemplatesGetResponsesContentApplicationJsonSchemaDataItemsId
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientLegalEntityId
Unique identifier of this resource.
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleEmploymentType
string
Type of employment arrangement
ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBreakdownCosts
object
Cost breakdown for the quote, grouped by billing cadence (e.g., monthly).
1 property
ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBenefitsItems
object
7 properties
ContractsGetResponsesContentApplicationJsonSchemaPage
object
Pagination information for the response.
2 properties
2 required
GetContractEquityWithholdingAmountRequestBadRequestError
object
ContractsPostResponsesContentApplicationJsonSchemaDataWorkerLegalEntityType
string
Type of a legal entity
EquityExercisePostResponsesContentApplicationJsonSchemaData
object
4 properties
4 required
ContractsContractIdPatchResponsesContentApplicationJsonSchemaQuote
object
EOR quote approved by Deel.
2 properties
ContractsContractIdPatchResponsesContentApplicationJsonSchemaCompensationDetails
object
Compensation and payment configuration for the contract.
11 properties
ContractsPostResponsesContentApplicationJsonSchemaDataClientLegalEntityType
string
Type of a legal entity
GetContractEquityWithholdingAmountRequestNotFoundError
object
RetrieveASingleContract-v2026-01-01RequestNotFoundError
object
2 properties
1 required
ApiErrorContainer
object
2 properties
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataSeniority
object
Seniority describes level of expertise at a job e.g. junior.
3 properties
ContractsGetResponsesContentApplicationJsonSchemaDataItemsWorkerAlternateEmailItems
object
Alternate email address object.
2 properties
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Client
object
Client details for the contract, including the legal entity and team.
2 properties
2 required
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCompensationDetails
object
Compensation and payment configuration for the contract.
11 properties
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleDaysItemsDay
string
Day of the week
ContractsContractIdPatchResponsesContentApplicationJsonSchemaQuoteBenefitsItems
object
7 properties
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3SeniorityId
Unique identifier of this resource.
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1SeniorityId
Unique identifier of this resource.
Contracts_signWorkerContract_Response_201
object
1 property
1 required
ApiErrorRequest
object
7 properties
ListOfContractsRequestBadRequestError
object
2 properties
1 required
CreateARequestToExerciseEquity-v2026-01-01RequestBadRequestError
object
1 property
1 required
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
ContractsPostResponsesContentApplicationJsonSchemaDataCompensationDetails
object
Compensation configuration and payment schedule details for the contract.
9 properties
9 required
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
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetails
object
12 properties
8 required
ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleEmploymentType
string
Type of employment arrangement
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
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2JobTitleId
Unique identifier of this resource.
CreateARequestToExerciseEquity-v2026-01-01RequestNotFoundError
object
1 property
1 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CompensationDetailsFrequency
string
Scale of the invoice cycle.
ContractsPostRequestBodyContentApplicationJsonSchemaData2
object
Details of contract to create
20 properties
6 required
ContractsContractIdPatchResponsesContentApplicationJsonSchemaClientTeam
object
Team information for the client organization.
2 properties
2 required
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataStatus
string
Status of a contract in Deel workflow.
ApproveAnEquityExercise-v2026-01-01RequestUnauthorizedError
object
1 property
1 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Client
object
Client details for the contract, including the legal entity and team.
2 properties
2 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1WhoReports
string
Flag to indicate who is supposed to provide regular reports
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CompensationDetailsCycleEndType
string
Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31.
ContractsContractIdPatchResponsesContentApplicationJsonSchemaEmploymentDetails
object
Employment-related details for the contract.
5 properties
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
ContractsGetResponsesContentApplicationJsonSchemaDataItems
object
17 properties
11 required
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClientTeam
object
Team information for the client organization.
2 properties
2 required
ContractsPostResponsesContentApplicationJsonSchemaDataSignatures
object
List of signatures recorded for this contract.
5 properties
5 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetailsFrequency
string
Scale of the invoice cycle.
RetrieveContractPdfDownloadLinkRequestBadRequestError
object
1 property
ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleDaysItems
object
Defines working hours for a specific day of the week
4 properties
4 required
ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkSchedule
object
Defines a work schedule including working days, hours, and employment details
7 properties
6 required
Contracts_approveAnEquityExercise-v2026-01-01_Response_200
object
5 properties
5 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…
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1JobTitleId
Unique identifier of this resource.
ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorker
object
Worker details associated with the contract.
10 properties
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataEmploymentType
string
Type of employment.
ContractsGetResponsesContentApplicationJsonSchemaDataItemsClient
object
Client information associated with the contract.
1 property
RejectContractRequestBadRequestError
object
1 property
ContractsContractIdPatchResponsesContentApplicationJsonSchemaInvitations
object
Invitation email addresses for signing the contract.
2 properties
ContractsContractIdPatchResponsesContentApplicationJsonSchemaClientTeamId
Unique identifier of this resource.
ApproveAnEquityExercise-v2026-01-01RequestNotFoundError
object
1 property
1 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Worker
object
Worker properties
4 properties
2 required
ApiError
object
2 properties
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetails
object
Compensation and invoicing configuration for the contract.
11 properties
6 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientTeamId
Unique identifier of this resource.
ContractsGetParametersCurrencies
ContractsPostResponsesContentApplicationJsonSchemaDataSeniority
object
Seniority describes level of expertise at a job e.g. junior
3 properties
2 required
CreateARequestToExerciseEquity-v2026-01-01RequestForbiddenError
object
1 property
1 required
ContractsContractIdPatchResponsesContentApplicationJsonSchemaEmploymentType
string
Type of employment.
ContractsGetResponsesContentApplicationJsonSchemaRequest
object
Error request details
2 properties
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3JobTitleId
Unique identifier of this resource.
ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleDaysItemsDay
string
Day of the week
ContractsPostResponsesContentApplicationJsonSchemaDataInvitations
object
List of signature invitations sent for this contract.
2 properties
ContractsContractIdGetResponsesContentApplicationJsonSchemaData
object
31 properties
14 required
ContractsPostResponsesContentApplicationJsonSchemaDataWorkerAlternateEmailItems
object
2 properties
2 required
ContractsPostResponsesContentApplicationJsonSchemaDataClientLegalEntity
object
Legal entity information for the client organization.
7 properties
7 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Seniority
object
Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels.
1 property
contracts_getContract_Response_200
object
1 property
1 required
ContractsGetParametersExpand
string
SignAmendmentRequestBadRequestError
object
2 properties
ContractsContractIdPatchResponsesContentApplicationJsonSchemaContractTemplate
object
Contract template details.
2 properties
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsCycleEndType
string
Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31.
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2SeniorityId
Unique identifier of this resource.
WorkersContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaData
object
1 property
1 required
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataQuote
object
EOR quote approved by Deel.
2 properties
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…
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
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataEmploymentDetails
object
Employment-related details for the contract.
5 properties
Contracts_retrieveContractPdfDownloadLink_Response_200
object
1 property
1 required
ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkerAlternateEmailItems
object
2 properties
ContractsPostResponsesContentApplicationJsonSchemaDataWorker
object
Worker details associated with the contract.
12 properties
ContractsContractIdPatchResponsesContentApplicationJsonSchemaCostCentersItems
object
3 properties
ContractsContractIdGetResponsesContentApplicationJsonSchemaErrorsItems
object
1 property
1 required
ContractsPostResponsesContentApplicationJsonSchemaDataClientTeam
object
Team information for the client organization.
2 properties
2 required
SignWorkerContractRequestInternalServerError
object
1 property
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Meta
object
Additional custom info about a contract
2 properties
1 required
ContractsContractIdPatchResponsesContentApplicationJsonSchemaStatus
string
Status of a contract in Deel workflow.
ContractsGetResponsesContentApplicationJsonSchemaDataItemsCostCentersItems
object
Cost center object.
3 properties
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Seniority
object
Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels.
1 property
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Meta
object
Additional custom info about a contract
2 properties
1 required
ContractsPostRequestBodyContentApplicationJsonSchemaData1
object
Details of contract to create
20 properties
7 required
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0WhoReports
string
Flag to indicate who is supposed to provide regular reports
ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Meta
object
Additional custom info about a contract
2 properties
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 Adjustments API
Deel Applications API
Deel Candidates API
Deel Contractor Amendments API
Deel Contractor Hiring API
Deel Contracts API
Deel Custom Fields API
Deel IT API
Deel EOR Amendments API
Deel EOR Benefits API
Deel EOR Cost Calculator API
Deel EOR Hiring 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.