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

The subpackage_people API from Deel — 5 operation(s) for subpackage_people.

Deel Subpackage People 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 6 operations across 5 paths, and defines 95 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.

6 operations 5 paths 95 schemas 3 GET2 POST1 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 People 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 6

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

subpackage_people 6
POST
/pwac
Create a person without a contract
create-person-without-contract 1 param body → 201400401403404500
GET
/people
List of People
get-people 14 params → 200400401403404500
POST
/people
Create a direct employee
create-a-direct-employee 1 param body → 201400401403404500
GET
/people/{hris_profile_id}
Retrieve a single person
get-person-by-id 4 params → 200400401403404500
PUT
/people/{id}/working-location
Update working location
update-person-working-location 2 params body → 200400401403404500
GET
/people/me
Get my current personal profile
get-my-current-personal-profile 1 param → 200400401403404500

Schemas 95

The contract defines 95 schemas that model the data the API accepts and returns. The most detailed are PeopleGetResponsesContentApplicationJsonSchemaDataItems (36 properties), PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaData (35 properties), PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItems (30 properties), PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItems (27 properties). Each schema is shown below with its type and property counts.

PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsTeam
object
The team to which the employee belongs.
2 properties
PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmailsItems
object
2 properties
PeopleGetResponsesContentApplicationJsonSchemaDataItemsPersonStatus
string
Lifecycle status of the person (worker profile). Omitted or null without peoplepersonstatus.view; excluded from the response when using fields if not requested.
PwacPostRequestBodyContentApplicationJsonSchemaDataClientTeam
object
3 properties 1 required
PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsPayment
object
Payment information for the employment, including rate, scale, currency, and associated contract name.
4 properties
people_updatePersonWorkingLocation_Response_200
object
1 property 1 required
PeoplePostRequestBodyContentApplicationJsonSchemaDataEmploymentOneOf1Type
string
The type of employment
PeoplePostRequestBodyContentApplicationJsonSchemaDataClientDepartment
object
The department information for the employee
1 property 1 required
people_getPeople_Response_200
object
2 properties 1 required
PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsContractCoverage
string
The coverage of the employment contract.
PeoplePostRequestBodyContentApplicationJsonSchemaDataCompensationDetails
object
The compensation details of the employee
3 properties 2 required
people_createPersonWithoutContract_Response_201
object
1 property 1 required
PwacPostResponsesContentApplicationJsonSchemaError
object
2 properties 2 required
PeoplePostResponsesContentApplicationJsonSchemaDataEmployee
object
The person that is being hired
6 properties 4 required
PeopleIdWorkingLocationPutRequestBodyContentApplicationJsonSchemaData
object
1 property 1 required
PwacPostRequestBodyContentApplicationJsonSchemaData
object
3 properties 2 required
PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsBandPlacement
string
Where the employee falls in their compensation band
PwacPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity
object
1 property 1 required
PeoplePostResponsesContentApplicationJsonSchemaDataEmployment
object
The employment details of the employee
8 properties 7 required
PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItemsTeamsItemsPositionsItemsRole
object
The role associated with this position, including role ID and name.
2 properties
PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsPayment
object
Payment information for the employment, including rate, scale, currency, and associated contract name.
4 properties
PeoplePostRequestBodyContentApplicationJsonSchemaDataClient
object
The entity that is hiring the employee
3 properties 2 required
PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItemsTeamsItemsPositionsItems
object
3 properties
PwacPostResponsesContentApplicationJsonSchemaDataPerson
object
The person that is being hired
13 properties 4 required
PeopleGetResponsesContentApplicationJsonSchemaDataItemsClientLegalEntity
object
The primary client legal entity associated with the employee.
2 properties
PwacPostRequestBodyContentApplicationJsonSchemaDataClient
object
3 properties 2 required
PwacPostRequestBodyContentApplicationJsonSchemaDataInvitationAction
string
Controls whether to send an invitation email.
PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployee
object
The person that is being hired
8 properties 5 required
PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItems
object
27 properties
PeopleGetResponsesContentApplicationJsonSchemaError
object
3 properties 2 required
PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataDepartment
object
The department of the employee.
3 properties
PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItems
object
30 properties
PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsClientLegalEntity
object
The client legal entity associated with this employment contract.
2 properties
CreateAPersonWithoutAContract-v2026-01-01RequestBadRequestError
object
1 property 1 required
people_getPersonById_Response_200
object
1 property 1 required
PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployment1
object
6 properties 4 required
PeoplePostResponsesContentApplicationJsonSchemaDataCompensationDetails
object
The compensation details of the employee
3 properties 2 required
PeopleGetParametersBandPlacementsSchemaItems
string
PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsTeam
object
The team to which the employee belongs.
2 properties
CreateADirectEmployeeRequestBadRequestError
object
1 property 1 required
ListOfPeople-v2026-01-01RequestInternalServerError
object
1 property 1 required
PeopleGetResponsesContentApplicationJsonSchemaDataItemsDirectReportsItems
object
4 properties
PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItems
object
3 properties
PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataDirectReportsItems
object
4 properties
PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployment0
object
7 properties 5 required
PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmailsItems
object
2 properties
PeopleGetParametersFieldsSchemaItems
string
PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataActiveWorkerTerminationStatus
string
The status of the active worker termination.
PeopleGetResponsesContentApplicationJsonSchemaDataItemsAddressesItems
object
5 properties
PeopleGetResponsesContentApplicationJsonSchemaPage
object
3 properties 3 required
PeoplePostRequestBodyContentApplicationJsonSchemaDataClientTeam
object
The team information for the employee
2 properties 1 required
PeoplePostResponsesContentApplicationJsonSchemaDataEmploymentType
string
The type of employment
PwacPostRequestBodyContentApplicationJsonSchemaDataPerson
object
The person that is being hired
14 properties 4 required
PeoplePostResponsesContentApplicationJsonSchemaError
object
2 properties 2 required
PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsHrisDirectEmployeeInvitation
object
The HRIS direct employee invitation status.
4 properties
PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaError
object
3 properties 2 required
PeopleGetParametersHiringTypesSchemaItems
string
PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsPaymentRate
The payment rate. Value is a string if contract type is PEO.
PeopleGetResponsesContentApplicationJsonSchemaDataItemsActiveWorkerTerminationStatus
string
The status of the active worker termination.
CreateAPersonWithoutAContract-v2026-01-01RequestInternalServerError
object
1 property 1 required
PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataClientLegalEntity
object
The primary client legal entity associated with the employee.
2 properties
PeoplePostResponsesContentApplicationJsonSchemaData
object
4 properties 4 required
PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataCustomFieldsItems
object
Customized attributes on people (Job title, Project code, etc).
2 properties
PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsHrisDirectEmployeeInvitation
object
The HRIS direct employee invitation status.
4 properties
PeoplePostRequestBodyContentApplicationJsonSchemaData
object
4 properties 4 required
PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataAddressesItems
object
5 properties
PeopleMeGetResponsesContentApplicationJsonSchemaProfileType
string
Type of profile
ApiErrorContainer
object
2 properties
PeopleIdWorkingLocationPutResponsesContentApplicationJsonSchemaData
object
1 property 1 required
ApiErrorRequest
object
7 properties
People_createADirectEmployee_Response_201
object
1 property 1 required
PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsContractCoverage
string
The coverage type of the employment contract. 'isshielded' = Contractor of Record, 'ispremium' = Premium, null = Standard (no coverage).
PeoplePostResponsesContentApplicationJsonSchemaDataCompensationDetailsScale
string
The scale at which the salary is paid
PeopleGetResponsesContentApplicationJsonSchemaDataItemsDirectManager
object
The direct manager of the employee.
5 properties
PeoplePostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsScale
string
The scale at which the salary is paid
PeoplePostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity
object
The legal entity information for the employee
1 property 1 required
CreateADirectEmployeeRequestInternalServerError
object
1 property 1 required
PeopleGetResponsesContentApplicationJsonSchemaDataItems
object
36 properties
ApiError
object
2 properties
PeopleGetParametersPersonStatusesSchemaItems
string
PwacPostRequestBodyContentApplicationJsonSchemaDataClientDepartment
object
1 property 1 required
People_getMyCurrentPersonalProfile_Response_200
object
People object representing a Deel
18 properties
PeopleGetResponsesContentApplicationJsonSchemaDataItemsDepartment
object
The department of the employee.
3 properties
PwacPostRequestBodyContentApplicationJsonSchemaDataInvitation
object
Optional invitation configuration for the new hire. Defaults to 'disable' if not provided.
1 property
PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaData
object
35 properties
RetrieveASinglePersonRequestInternalServerError
object
1 property 1 required
PeoplePostRequestBodyContentApplicationJsonSchemaDataEmploymentOneOf0Type
string
The type of employment
PwacPostResponsesContentApplicationJsonSchemaData
object
2 properties 2 required
PeopleGetParametersSortOrder
string
PeopleGetParametersHiringStatusesSchemaItems
string
PeopleGetParametersSortBy
string
PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployment
The employment details of the employee
PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataDirectManager
object
The direct manager of the employee.
5 properties
PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItemsTeamsItems
object
4 properties
PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsClientLegalEntity
object
The client legal entity associated with this employment contract.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

deel-com-subpackage-people-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 People 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.