How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Deel Subpackage Custom Fields Contracts API

The subpackage_customFieldsContracts API from Deel — 4 operation(s) for subpackage_customfieldscontracts.

Deel Subpackage Custom Fields 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.

Tagged areas include subpackage_customFieldsContracts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 4 operations across 4 paths, and defines 44 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.

4 operations 4 paths 44 schemas 1 DELETE2 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.letsdeel.com/rest/v2
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Deel Subpackage Custom Fields 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 4

Across 4 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

subpackage_customFieldsContracts 4
DELETE
/contracts/{contract_id}/custom_fields/{id}
Delete Contract custom field by Id
delete-contract-custom-field 3 params → 204400401403404500
GET
/contracts/custom_fields/{id}
Get custom fields from contracts
get-custom-field 2 params → 200400401403404500
GET
/contracts/custom_fields
List all custom fields
get-contract-custom-fields 1 param → 200400401403404500
PUT
/contracts/{contract_id}/custom_fields
Update custom field value
put-contract-custom-field 2 params body → 200400401403404500

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems (7 properties), ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaData (7 properties), ApiErrorRequest (7 properties), ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettings (5 properties). Each schema is shown below with its type and property counts.

ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType0
object
Simple custom field types
1 property
ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData3
object
Percentage type
1 property
ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf1Name
string
Currency type
ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType2
object
2 properties 2 required
ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataPlacement
string
Where the custom field is displayed
custom-fields-contracts_deleteContractCustomField_Response_204
object
Empty response body
ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf0Name
string
Simple types
GetCustomFieldsFromContractsRequestInternalServerError
object
1 property 1 required
ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaData
object
Custom field object
7 properties
ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData6
object
Multiselect type
1 property
ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType1
object
3 properties 2 required
ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccessProvidedBy
string
Entity providing access to the custom field
ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData0
object
Text type
1 property
ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsWorkerTypesItems
string
ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccess
object
Access settings for the custom field
3 properties 1 required
ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData1
object
Number type
1 property
ApiError
object
2 properties
ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData5
object
List type
1 property
ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsPlacement
string
Valid placements for custom field
custom-fields-contracts_getCustomField_Response_200
object
Response wrapper object
1 property 1 required
ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType
Type configuration of the custom field including its data type and type-specific properties
custom-fields-contracts_putContractCustomField_Response_200
object
Empty response body
ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf1Name
string
Currency field type
ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType1
object
Currency custom field type
3 properties
ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType0
object
1 property 1 required
ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettings
object
Configuration settings for the custom field including requirements, visibility, and access controls
5 properties 3 required
ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaError
object
3 properties 2 required
ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems
object
7 properties 5 required
ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType2
object
List or multiselect custom field type
2 properties
ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccessProvidedBy
string
Entity providing access
ApiErrorContainer
object
2 properties
ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData
ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettings
object
Configuration settings for the custom field
5 properties
ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsWorkerTypesItems
string
Worker type
ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf0Name
string
Simple field type
ApiErrorRequest
object
7 properties
custom-fields-contracts_getContractCustomFields_Response_200
object
1 property 1 required
ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccess
object
Access control settings
2 properties
ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf2Name
string
List types
ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData2
object
Date type: YYYY-MM-DD
1 property
ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType
Type definition of the custom field
ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData4
object
Currency type
2 properties
ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf2Name
string
List field type
ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaData
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

deel-com-subpackage-customfieldscontracts-api-openapi.yml Raw ↑

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 Custom Fields 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.