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_customFieldsPeople API

The subpackage_customFieldsPeople API from Deel — 4 operation(s) for subpackage_customfieldspeople.

Deel subpackage_customFieldsPeople 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.

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

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

5 operations 4 paths 54 schemas 1 DELETE3 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Servers
https://api.letsdeel.com/rest/v2
https://api-staging.letsdeel.com/rest/v2
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Deel subpackage_customFieldsPeople 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 5

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

subpackage_customFieldsPeople 5
DELETE
/people/{worker_id}/custom_fields/{id}
Delete the custom field value from Worker by Id
delete-person-custom-field 3 params → 204400401403404500
GET
/people/custom_fields/{id}
Get custom field from people by id
get-person-custom-field 2 params → 200400401403404500
GET
/people/custom_fields
List all people custom fields
get-custom-fields 1 param → 200400401403404500
GET
/people/{worker_id}/custom_fields
Retrieve custom fields for a worker
get-person-custom-fields 2 params → 200400401403404500
PUT
/people/{worker_id}/custom_fields
Update custom field value
put-person-custom-field 2 params body → 200400401403404500

Schemas 54

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

PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData4
object
Currency type
2 properties
PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType0
object
1 property 1 required
PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettings
object
5 properties
PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType
PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData6
object
Multiselect type
1 property
PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData3
object
Percentage type
1 property
ListAllPeopleCustomFieldsRequestInternalServerError
object
1 property
PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData
PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems
object
7 properties
PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf1Name
string
Currency type
PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaData
object
2 properties 2 required
PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsPlacement
string
Valid placements for custom field
PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccessProvidedBy
string
Entity providing access to the custom field
PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf1Name
string
Currency type
PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData1
object
Number type
1 property
PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData1
object
Number type
1 property
PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData2
object
Date type: YYYY-MM-DD
1 property
PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaData
object
7 properties
PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataPlacement
string
Valid placements for custom field
PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType2
object
2 properties 2 required
PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf0Name
string
Simple types
PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData6
object
Multiselect type
1 property
PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData
PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData5
object
List type
1 property
custom-fields-people_getPersonCustomFields_Response_200
object
1 property 1 required
ApiError
object
2 properties
custom-fields-people_putPersonCustomField_Response_200
object
Empty response body
PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf2Name
string
List types
PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData3
object
Percentage type
2 properties
PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData5
object
List type
1 property
PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsWorkerTypesItems
string
ApiErrorContainer
object
2 properties
PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems
object
4 properties 4 required
PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData2
object
Date type: YYYY-MM-DD
1 property
PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType0
object
1 property
PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccess
object
Access settings for the custom field
2 properties
custom-fields-people_getPersonCustomField_Response_200
object
1 property 1 required
PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType
Type of the custom field
PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType1
object
3 properties 2 required
PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType1
object
3 properties
custom-fields-people_deletePersonCustomField_Response_204
object
Empty response body
PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType
string
Type of the custom field
PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccessProvidedByItems
string
PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData4
object
Currency type
2 properties
PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData0
object
Text type
1 property
PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf2Name
string
List types
PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettings
object
Settings for the custom field
5 properties 3 required
PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData0
object
Text type
1 property
PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsWorkerTypesItems
string
PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf0Name
string
Simple types
PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType2
object
2 properties
PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccess
object
Access settings for the custom field
3 properties 1 required
custom-fields-people_getCustomFields_Response_200
object
1 property 1 required
ApiErrorRequest
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

deel-subpackage-customfieldspeople-api-openapi.yml Raw ↑

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_contracts API
Deel subpackage_costCalculator API
Deel subpackage_costCenters API
Where this information came from

This is an independent, third-party profile of Deel subpackage_customFieldsPeople 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.