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

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

Deel subpackage_users 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.

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 45 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.

3 operations 3 paths 45 schemas 2 GET1 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_users 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 — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

subpackage_users 3
GET
/Users
List users
get-users 4 params → 200400401403429500
GET
/Users/{hrisProfileOid}
Retrieve a single User
get-user-by-id 2 params → 200401403404429500
POST
/Users/.search
Search or list users
search-users 1 param body → 200400401403429500

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20User (19 properties), UserExtension (17 properties), UsersGetResponsesContentApplicationJsonSchemaResourcesItems (12 properties), UserResponse (12 properties). Each schema is shown below with its type and property counts.

Name
object
2 properties 2 required
UsersGetResponsesContentApplicationJsonSchemaResourcesItemsName
object
2 properties 2 required
CountryCode
string
MetaResourceType
string
UserExtensionEmploymentsItems
object
8 properties
ListUsers-v2026-01-01RequestInternalServerError
object
1 property 1 required
Meta
object
Resource metadata.
4 properties
UsersGetResponsesContentApplicationJsonSchemaResourcesItemsMetaResourceType
string
UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserOrganizationalStructuresItems
object
6 properties
UserResponse
object
12 properties 5 required
UsersGetResponsesContentApplicationJsonSchemaResourcesItemsEmailsItemsType
string
CustomField
object
3 properties
SearchRequestSchemasItems
string
Email
object
3 properties 2 required
UsersGetResponsesContentApplicationJsonSchemaResourcesItemsEmailsItems
object
3 properties 2 required
OrganizationalStructure
object
6 properties
UserSearchResponse
object
5 properties
EnterpriseUser
object
4 properties
UsersGetResponsesContentApplicationJsonSchemaResourcesItemsSchemasItems
string
UsersGetResponsesContentApplicationJsonSchemaResourcesItemsAddressesItems
object
7 properties
UserExtension
object
17 properties
EmailType
string
UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtensionEnterprise20UserManager
object
3 properties 1 required
ErrorResponse
object
4 properties
UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtensionEnterprise20User
object
7 properties
UsersGetResponsesContentApplicationJsonSchemaSchemasItems
string
UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20User
object
19 properties
UserExtensionEmploymentsItemsTeam
object
Team name.
1 property
UsersGetResponsesContentApplicationJsonSchemaResourcesItems
object
12 properties 5 required
UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserCustomFieldsItems
object
3 properties
UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItems
object
10 properties
ErrorResponseSchemasItems
string
UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsCustomFieldsItems
object
4 properties
UsersGetResponsesContentApplicationJsonSchemaResourcesItemsMeta
object
4 properties
UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsCustomFieldsItemsData
object
The custom field value payload. Structure varies by field type: Text/Number/Date have {value}, Percentage has {value, text}, Currency has {amount, currency}, L…
Manager
object
3 properties 1 required
UserSearchResponseSchemasItems
string
UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsTeam
object
1 property
Address
object
6 properties
SearchRequest
object
4 properties
UsersGetResponsesContentApplicationJsonSchemaError
object
3 properties 2 required
Users_getUsers_Response_200
object
5 properties
UsersGetParametersFilter
ErrorResponseScimType
string
bad request type when status code is 400
UserSchemasItems
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

deel-subpackage-users-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_users 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.