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

The subpackage_gpHiring API from Deel — 2 operation(s) for subpackage_gphiring.

Deel subpackage_gpHiring 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_gpHiring. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

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

2 operations 2 paths 40 schemas 2 POST

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_gpHiring 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 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

subpackage_gpHiring 2
POST
/contracts/gp
Create a Global Payroll (GP) contract
create-gp-contract 1 param body → 201400401403404500
POST
/gp/workers/{worker_id}/terminations
Request termination
create-gp-worker-termination 2 params body → 201400401403404500

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are ContractsGpPostResponsesContentApplicationJsonSchemaData (9 properties), ApiErrorRequest (7 properties), ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployee (7 properties), ContractsGpPostResponsesContentApplicationJsonSchemaDataEmployment (7 properties). Each schema is shown below with its type and property counts.

ContractsGpPostRequestBodyContentApplicationJsonSchemaData
object
7 properties 5 required
GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeverance
ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployeeAddressCountry
string
ISO 3166-1 alpha-2 country code.
ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmploymentCountry
string
Country where the employee is employed, in ISO 3166-1 alpha-2 format. Used as the contract country. Falls back to employee address country if not provided.
ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployment
object
4 properties 3 required
ContractsGpPostRequestBodyContentApplicationJsonSchemaDataWorkLocation
object
Work location details for the employee. Required for US legal entities.
3 properties 1 required
ContractsGpPostResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeveranceOneOf1Type
string
The type of severance, in cash.
ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployee
object
7 properties 5 required
GpWorkersWorkerIdTerminationsPostResponsesContentApplicationJsonSchemaData
object
2 properties 2 required
ContractsGpPostRequestBodyContentApplicationJsonSchemaDataClientTeam
object
1 property 1 required
ContractsGpPostResponsesContentApplicationJsonSchemaDataType
string
Type of a contract.
ContractsGpPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsScale
string
Defines whether the salary amount represents yearly or monthly gross compensation.
ContractsGpPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity
object
1 property 1 required
ContractsGpPostResponsesContentApplicationJsonSchemaDataClient
object
1 property
ContractsGpPostResponsesContentApplicationJsonSchemaDataClientLegalEntity
object
1 property
ContractsGpPostResponsesContentApplicationJsonSchemaDataEmploymentHolidays
object
2 properties
ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployeeAddress
object
5 properties 4 required
GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeveranceOneOf0Type
string
The type of severance, either in time off.
ContractsGpPostResponsesContentApplicationJsonSchemaDataEmployment
object
7 properties
ContractsGpPostRequestBodyContentApplicationJsonSchemaDataClient
object
2 properties 2 required
GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeverance1
object
3 properties 3 required
ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployeeNationality
string
Employee's nationality in ISO 3166-1 alpha-2 format.
ApiError
object
2 properties
GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeveranceOneOf0TimeUnit
string
The unit of time for severance (e.g., DAYS, WEEKS, MONTHS).
gp-hiring_createGPContract_Response_201
object
1 property 1 required
ApiErrorContainer
object
2 properties
ContractsGpPostResponsesContentApplicationJsonSchemaData
object
9 properties
ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmploymentHolidays
object
2 properties 2 required
ContractsGpPostResponsesContentApplicationJsonSchemaDataStatus
string
Status of a contract in Deel workflow.
CreateAGlobalPayrollGpContract-v2026-01-01RequestInternalServerError
object
1 property
GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaData
object
5 properties 5 required
gp-hiring_createGPWorkerTermination_Response_201
object
1 property 1 required
CreateAGlobalPayrollGpContract-v2026-01-01RequestBadRequestError
object
1 property
GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeverance0
object
4 properties 4 required
ContractsGpPostResponsesContentApplicationJsonSchemaDataCompensationDetails
object
3 properties
ContractsGpPostRequestBodyContentApplicationJsonSchemaDataCompensationDetails
object
3 properties 2 required
ContractsGpPostResponsesContentApplicationJsonSchemaDataEmployee
object
4 properties
ApiErrorRequest
object
7 properties
ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmploymentType
string
Employment type indicating whether the employee works full-time or part-time.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

deel-subpackage-gphiring-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_gpHiring 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.