New Custom Fields endpoints for Deel HR

Added

List all custom fields

Fetch all custom fields associated with People records, offering additional personalized information.

Endpoint: GET /rest/v2/contracts/contract_id/adjustments

Sample Request

curl --request GET \
     --url https://api.letsdeel.com/rest/v2/people/custom_fields \
     --header 'authorization: Token'

Retrieve a single custom field

Access details of a specific custom field by using the custom field ID to enrich individual personnel records.

Endpoint: GET /rest/v2/people/custom_fields/{field_id}

curl --request GET \
     --url https://api.letsdeel.com/rest/v2/people/custom_fields/field_id \
     --header 'accept: application/json' \
     --header 'authorization: Bearer Token'

Retrieve custom fields for a worker

Obtain all custom field values associated with a specific worker, facilitating detailed data retrieval for administrative or operational purposes.

Endpoint: GET /rest/v2/people/{worker_id}/custom_fields

curl --request GET \
     --url https://api.letsdeel.com/rest/v2/people/worker_id/custom_fields \
     --header 'accept: application/json' \
     --header 'authorization: Bearer Token'

Update custom field value

Add or update custom field values for a specific worker, ensuring their profile is up-to-date with the latest information.

Endpoint: PUT /rest/v2/people/{worker_id}/custom_fields

curl --request PUT \
     --url https://api.letsdeel.com/rest/v2/people/worker_id/custom_fields \
     --header 'accept: application/json' \
     --header 'authorization: Bearer Token' \
     --header 'content-type: application/json' \
     --data '
{
  "data": {
    "value": "Test"
  },
  "id": "4e5c8303-6368-4eff-9a50-df21018450e7"
}
'

Remove a custom field value

Delete a specific custom field value from a worker's profile, removing outdated or unnecessary information.

Endpoint: DELETE /rest/v2/people/{worker_id}/custom_fields/{field_id}

curl --request DELETE \
     --url https://api.letsdeel.com/rest/v2/people/5d4d076e-283e-461f-b492-94d043c1d21a/custom_fields/ba5af1fa-e0c1-474f-8e13-af5d08a8c32c \
     --header 'accept: application/json' \
     --header 'authorization: Bearer Token'

List all custom fields

Fetch all custom fields associated with contracts, providing additional data necessary for contract management.

Endpoint: GET /rest/v2/contracts/custom_fields

curl --request GET \
     --url https://api.letsdeel.com/rest/v2/contracts/custom_fields \
     --header 'accept: application/json' \
     --header 'authorization: Bearer Token'

Retrieve a specific custom

Access details of a specific custom field associated with a contract to manage contract-specific attributes effectively.

Endpoint: GET /rest/v2/contracts/custom_fields/{field_id}

curl --request GET \
     --url https://api.letsdeel.com/rest/v2/contracts/custom_fields/field_id \
     --header 'accept: application/json' \
     --header 'authorization: Bearer Token'

Retrieve custom fields for a contract

Obtain all custom field values for a specific contract, enhancing contract management with detailed, custom-configured data.

Endpoint: GET /rest/v2/contracts/{contract_id}/custom_fields

curl --request GET \
     --url https://api.letsdeel.com/rest/v2/contracts/ej3yko/custom_fields \
     --header 'accept: application/json' \
     --header 'authorization: Bearer Token'

Update custom field value

Add or update custom field values for a specific contract, ensuring all contract details are current and relevant.

Endpoint: PUT /rest/v2/contracts/{contract_id}/custom_fields

curl --request PUT \
     --url https://api.letsdeel.com/rest/v2/contracts/fke32a/custom_fields \
     --header 'accept: application/json' \
     --header 'authorization: Bearer Token' \
     --header 'content-type: application/json' \
     --data '
{
  "data": {
    "value": "Test"
  },
  "id": "3634384c-dcbd-4d22-a53c-82b6b35b9221"
}
'

Remove a custom field value

Delete a specific custom field’s value from a contract, streamlining contract data management by removing redundant or outdated information.

Endpoint: DELETE /rest/v2/contracts/{contract_id}/custom_fields/{field_id}

curl --request DELETE \
     --url https://api.letsdeel.com/rest/v2/contracts/rk43an/custom_fields/581b0c3e-02d4-4d81-afe7-5bdce64632b1 \
     --header 'accept: application/json' \
     --header 'authorization: Bearer Token'