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

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

Deel Subpackage Workers 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 5 operations across 5 paths, and defines 49 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.

5 operations 5 paths 49 schemas 4 GET1 POST

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 Workers 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 5

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

subpackage_workers 5
GET
/ic/workers/invoices/{invoice_id}/pdf
/ic/workers/invoices/:invoiceid/pdf
ic-workers-invoices-invoice-id-pdf-v-2026-04-20 2 params → 200400401403404412500
POST
/worker
Create a new worker
create-worker 1 param body → 201400401403404500
GET
/ic/workers/invoices/{invoice_id}
Get invoice details by ID
get-invoice-details-by-id-v-2026-04-27 2 params → 200400401403404412500
GET
/workers/compliance-documents
List of worker compliance documents
list-of-worker-compliance-documents-v-2026-04-23 1 param → 200400401403404500
GET
/ic/workers/transactions
Retrieve worker transaction history
retrieve-worker-transaction-history-v-2026-04-30 15 params → 200400401403404412500

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItems (14 properties), WorkerPostRequestBodyContentApplicationJsonSchemaDataCompanyPersonal (13 properties), WorkerPostRequestBodyContentApplicationJsonSchemaData (11 properties), IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaData (9 properties). Each schema is shown below with its type and property counts.

IcWorkersInvoicesInvoiceIdPdf-v2026-04-20RequestUnauthorizedError
object
1 property 1 required
WorkerPostRequestBodyContentApplicationJsonSchemaDataProfileType
string
Type of worker profile
CreateWorkerRequestInternalServerError
object
1 property
WorkerPostRequestBodyContentApplicationJsonSchemaDataCompanyType
string
Type of company registration
RetrieveWorkerTransactionHistory-v2026-04-30RequestPreconditionFailedError
object
1 property 1 required
RetrieveWorkerTransactionHistory-v2026-04-30RequestInternalServerError
object
1 property 1 required
GetInvoiceDetailsById-v2026-04-27RequestPreconditionFailedError
object
1 property 1 required
IcWorkersInvoicesInvoiceIdPdf-v2026-04-20RequestPreconditionFailedError
object
1 property 1 required
GetInvoiceDetailsById-v2026-04-27RequestBadRequestError
object
1 property 1 required
IcWorkersTransactionsGetParametersFilter
string
IcWorkersTransactionsGetResponsesContentApplicationJsonSchemaRequest
object
Present for some public API responses (e.g. when x-is-api-call is set).
3 properties
CreateWorkerRequestBadRequestError
object
1 property
WorkerPostResponsesContentApplicationJsonSchemaData
object
3 properties 3 required
WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItems
object
14 properties 13 required
Workers_retrieveWorkerTransactionHistory-v2026-04-30_Response_200
object
4 properties 3 required
ListOfWorkerComplianceDocuments-v2026-04-23RequestInternalServerError
object
1 property
IcWorkersInvoicesInvoiceIdPdf-v2026-04-20RequestInternalServerError
object
1 property 1 required
IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaRequest
object
Present for some public API responses (e.g. when x-is-api-call is set).
3 properties
ApiError
object
2 properties
Workers_createWorker_Response_201
object
1 property 1 required
GetInvoiceDetailsById-v2026-04-27RequestForbiddenError
object
2 properties 1 required
WorkerPostRequestBodyContentApplicationJsonSchemaDataCompanyPersonal
object
13 properties 6 required
IcWorkersInvoicesInvoiceIdPdf-v2026-04-20RequestBadRequestError
object
1 property 1 required
IcWorkersTransactionsGetResponsesContentApplicationJsonSchemaErrorsItems
object
4 properties 2 required
IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataPaymentDisplayStatus
object
Derived payment display state for the invoice.
2 properties 2 required
GetInvoiceDetailsById-v2026-04-27RequestInternalServerError
object
1 property 1 required
IcWorkersTransactionsGetResponsesContentApplicationJsonSchemaDataItems
object
One contractor transaction; id is the public transaction UUID.
5 properties 2 required
WorkerPostRequestBodyContentApplicationJsonSchemaData
object
11 properties 7 required
Workers_icWorkersInvoicesInvoiceIdPdf-v2026-04-20_Response_200
object
Envelope containing a time-limited signed URL to the invoice PDF.
1 property 1 required
WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties 2 required
RetrieveWorkerTransactionHistory-v2026-04-30RequestForbiddenError
object
2 properties 1 required
RetrieveWorkerTransactionHistory-v2026-04-30RequestUnauthorizedError
object
1 property 1 required
IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems
object
4 properties 2 required
RetrieveWorkerTransactionHistory-v2026-04-30RequestBadRequestError
object
1 property 1 required
IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaData
object
Payload with the signed download URL.
1 property 1 required
IcWorkersTransactionsGetParametersTransactionType
string
IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaData
object
Invoice summary (snakecase; display card fields, amounts, and payment display).
9 properties 4 required
ApiErrorContainer
object
2 properties
WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus
string
Review status of the uploaded document, null if no document has been uploaded yet.
WorkerPostRequestBodyContentApplicationJsonSchemaDataCompany
object
2 properties 2 required
IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaRequest
object
Present for some public API responses (e.g. when x-is-api-call is set).
3 properties
WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaData
object
1 property 1 required
ApiErrorRequest
object
7 properties
IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaErrorsItems
object
4 properties 2 required
Workers_getInvoiceDetailsById-v2026-04-27_Response_200
object
1 property 1 required
ListOfWorkerComplianceDocuments-v2026-04-23RequestForbiddenError
object
1 property
GetInvoiceDetailsById-v2026-04-27RequestUnauthorizedError
object
1 property 1 required
IcWorkersInvoicesInvoiceIdPdf-v2026-04-20RequestForbiddenError
object
2 properties 1 required
Workers_listOfWorkerComplianceDocuments-v2026-04-23_Response_200
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

deel-com-subpackage-workers-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 Workers 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.