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 Global Payroll API

The subpackage_globalPayroll API from Deel — 3 operation(s) for subpackage_globalpayroll.

Deel Subpackage Global Payroll 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.

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

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

3 operations 3 paths 48 schemas 3 GET

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 Global Payroll 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 3

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

subpackage_globalPayroll 3
GET
/gp/workers/{id}/payslips/{payslip_id}/download
Download a GP worker payslip
download-a-gp-worker-payslip-v-2026-01-01 4 params → 200400401403404500
GET
/cycles/{cycle_id}/payroll-report
Get Payroll Report
get-payroll-report-v-2026-03-30 7 params → 200400401403404500
GET
/forms/gp/worker-additional-fields/{country_code}
Retrieve additional information fields for GP workers by country
retrieve-additional-information-fields-for-gp-workers-by-country-v-2026-01-01 2 params → 200400401403404429500

Schemas 48

The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPayrollReportItemsItemsPayrollReportColumn (29 properties), CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEventEntityItemsItems (29 properties), CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPayrollReportItemsItems (16 properties), CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPreviousPayrollReportItemsItems (14 properties). Each schema is shown below with its type and property counts.

FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItems
object
2 properties 2 required
GpWorkersIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaRequest
object
Error request details
2 properties
CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaData
object
5 properties 3 required
FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsValidationItems
object
3 properties 2 required
CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPreviousPayrollReportItemsItemsEmploymentPayrollEventId
Employment payroll event id.
FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItems
object
8 properties 6 required
FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsType
string
Use this value to determine the data type expected when submitting field values. Mapped from the raw input type: 'date', 'text', 'select', 'textarea', 'tel', '…
CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsContractHrisProfile
object
HRIS profile details.
1 property
Global_Payroll_downloadAGpWorkerPayslip-v2026-01-01_Response_200
object
1 property 1 required
FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue3
object
2 properties 2 required
CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPayrollReportItemsItems
object
16 properties
FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue
Use this value to evaluate the dependency condition. When the value is a primitive (string, number, or boolean), the condition is satisfied when the referenced…
CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataOverview
object
Optional aggregated overview for the report.
ApiError
object
2 properties
FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems
object
1 property 1 required
CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItems
object
4 properties
CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsEmploymentEmployeeRecurringItemsItemsPayrollReportColumn
object
Payroll report column details.
GpWorkersIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaData
object
1 property 1 required
RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestInternalServerError
object
1 property
Global_Payroll_retrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01_Response_200
object
1 property 1 required
RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestUnauthorizedError
object
1 property 1 required
GpWorkersIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems
object
1 property 1 required
CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPayrollReportItemsItemsUpdatedByProfile
object
Profile of the user who last updated the item.
3 properties
CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEventEntityItemsItems
object
29 properties
CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsEmploymentEmployee
object
Employee name details.
3 properties
RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestNotFoundError
object
1 property 1 required
FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsUiGuide
object
Use this object to control how the field is rendered in the UI. Contains labels, input type, display order, and supplementary text.
6 properties 6 required
GetPayrollReport-v2026-03-30RequestBadRequestError
object
1 property
CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPreviousPayrollReportItemsItemsPayrollReportColumn
object
Payroll report column details.
CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataCursor
Cursor for pagination.
RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestBadRequestError
object
1 property 1 required
CyclesCycleIdPayrollReportGetParametersCursor
CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsEmploymentEmployeeRecurringItemsItemsAmount
Recurring item amount.
CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsContract
object
Contract details for the employee.
6 properties
ApiErrorContainer
object
2 properties
CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPayrollReportItemsItemsPayrollReportColumn
object
Payroll report column details.
29 properties
CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsEmploymentEmployeeRecurringItemsItems
object
5 properties
RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestForbiddenError
object
1 property 1 required
CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPreviousPayrollReportItemsItems
object
14 properties
CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsEmployment
object
4 properties
ApiErrorRequest
object
7 properties
Global_Payroll_getPayrollReport-v2026-03-30_Response_200
object
1 property 1 required
CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPayrollReportItemsItemsEmploymentPayrollEventId
Employment payroll event id.
DownloadAGpWorkerPayslip-v2026-01-01RequestBadRequestError
object
2 properties 1 required
FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValueOneOf3Op
string
Use this operator to evaluate the dependency condition against the referenced field's submitted value.
RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestTooManyRequestsError
object
1 property 1 required
CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
GetPayrollReport-v2026-03-30RequestInternalServerError
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

deel-com-subpackage-globalpayroll-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 Global Payroll 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.