Deel REST API

GET `/people/external/{worker_id}/personal`

Get worker profile by external ID

worker_id

System-wide external identifier for a worker record.

Response

GET `/people/custom_fields/{id}`

Get custom field from people by id

Custom field id.

Response

GET `/people/{worker_id}/custom_fields`

Retrieve custom fields for a worker

worker_id

Worker id.

Response

PUT `/people/{worker_id}/custom_fields`

Update custom field value

worker_id

Worker id.

Request Body

Response

GET `/people/{worker_id}/personal`

Get personal information by id

worker_id

Unique identifier for a worker (External ID).

Response

GET `/people/{hris_profile_id}`

Retrieve a single person

Include custom fields in the response.

include_custom_fields

Include worker relations in the response.

include_worker_relations

hris_profile_id

Unique identifier for the person.

Response

GET `/people`

List of People

offset

Return a page of results with given number of records.

limit

Return a page of results with given number of records.

Include a contract if by name or contractor name contains given search term.

teams (JSON array)

Filter the results based on the team(group) the users contract is associated with

fields (JSON array)

Pick the fields you want to see in the response in order to avoid a bloated people list output. Supports dot notation (e.g., 'employments[0].contract_status') to access nested fields.

sort_by

Sort people by given field name.

sort_order

Order direction of results; ascending or descending.

hiring_statuses (JSON array)

Employee's current hiring status.

band_placements (JSON array)

Employee's current band placement.

comparative_ratios_from

Employee's minimum band placement

comparative_ratios_to

Employee's maximum band placement

hiring_types (JSON array)

Filter people by hiring types

person_statuses (JSON array)

Filter people by person (worker profile) lifecycle status.

Response

POST `/people`

Create a direct employee

Request Body

Response

DELETE `/people/{worker_id}/custom_fields/{id}`

Delete the custom field value from Worker by Id

Custom field id.

worker_id

Worker id.

Response

PUT `/people/{id}/working-location`

Update working location

Hris profile ID

Request Body

Response

GET `/people/me`

Get my current personal profile

Response

GET `/people/custom_fields`

List all people custom fields

Response

PUT `/people/{id}/department`

Update organization structure

Indicates if this department position should replace all other positions or only append to the existing ones.

replace_other_positions

Hris profile ID

Request Body

Response

Deel REST API

API Endpoints

GET /people/external/{worker_id}/personal

GET /people/custom_fields/{id}

GET /people/{worker_id}/custom_fields

PUT /people/{worker_id}/custom_fields

GET /people/{worker_id}/personal

GET /people/{hris_profile_id}

GET /people

POST /people

DELETE /people/{worker_id}/custom_fields/{id}

PUT /people/{id}/working-location

GET /people/me

GET /people/custom_fields

PUT /people/{id}/department

GET `/people/external/{worker_id}/personal`

GET `/people/custom_fields/{id}`

GET `/people/{worker_id}/custom_fields`

PUT `/people/{worker_id}/custom_fields`

GET `/people/{worker_id}/personal`

GET `/people/{hris_profile_id}`

GET `/people`

POST `/people`

DELETE `/people/{worker_id}/custom_fields/{id}`

PUT `/people/{id}/working-location`

GET `/people/me`

GET `/people/custom_fields`

PUT `/people/{id}/department`