Deel Subpackage Candidates API
The subpackage_candidates API from Deel — 1 operation(s) for subpackage_candidates.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/deel-com:deel-com-subpackage-candidates-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Endpoints Subpackage Candidates API
version: 1.0.0
servers:
- url: https://api.letsdeel.com/rest/v2
- url: https://api-staging.letsdeel.com/rest/v2
tags:
- name: subpackage_candidates
paths:
/candidates:
post:
operationId: add-candidate
summary: Add Candidate
description: 'Add a candidate to Deel.
**Token scopes**: `candidates:write`'
tags:
- subpackage_candidates
parameters:
- name: Authorization
in: header
description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n"
required: true
schema:
type: string
responses:
'201':
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/Candidates_addCandidate_Response_201'
'400':
description: Operation failed.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorContainer'
'401':
description: Operation failed.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorContainer'
'403':
description: Operation failed.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorContainer'
'404':
description: Operation failed.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorContainer'
'500':
description: Operation failed.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorContainer'
requestBody:
description: Add a candidate to Deel
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/CandidatesPostRequestBodyContentApplicationJsonSchemaData'
description: Details of candidate to create
required:
- data
components:
schemas:
CandidatesPostResponsesContentApplicationJsonSchemaData:
type: object
properties:
created:
type: boolean
description: Indicates if the candidate was created successfully.
required:
- created
title: CandidatesPostResponsesContentApplicationJsonSchemaData
CandidatesPostRequestBodyContentApplicationJsonSchemaDataStatus:
type: string
enum:
- offer-accepted
- offer-sent
- offer-declined
- offer-deleted
description: Offer status
title: CandidatesPostRequestBodyContentApplicationJsonSchemaDataStatus
ApiErrorRequest:
type: object
properties:
method:
type: string
description: The HTTP method of the failed request
url:
type: string
description: The relative URL of the failed request
status:
type: number
format: double
description: The status code of the response
api_req_id:
type: string
description: The request ID of the failed request
docs:
type: string
description: A link to the official documentation for the requested endpoint resource
source:
type: string
description: The source handler which produced the returned error
code:
type: number
format: double
description: The code of the source handler which produced the returned error
title: ApiErrorRequest
ApiError:
type: object
properties:
message:
type: string
description: A description of the returned error
path:
type: string
description: The JSON path where input validation failed
title: ApiError
CandidatesPostRequestBodyContentApplicationJsonSchemaData:
type: object
properties:
id:
type: string
description: Unique identifier of candidate in your ATS.
link:
type: string
description: Link to candidate's profile in ATS.
email:
type: string
format: email
description: Worker's work email address.
state:
type: string
description: Job location state.
status:
$ref: '#/components/schemas/CandidatesPostRequestBodyContentApplicationJsonSchemaDataStatus'
description: Offer status
country:
type: string
description: Country code.
job_title:
type: string
description: Job Title.
last_name:
type: string
description: Candidate's last name.
first_name:
type: string
description: Candidate's first name.
start_date:
type: string
format: date
description: Short date in format ISO-8601 (YYYY-MM-DD).
nationality:
type: string
description: Nationality of the worker.
personal_email:
type: string
format: email
description: Worker's personal email address.
required:
- id
- link
- status
- last_name
- first_name
- start_date
description: Details of candidate to create
title: CandidatesPostRequestBodyContentApplicationJsonSchemaData
Candidates_addCandidate_Response_201:
type: object
properties:
data:
$ref: '#/components/schemas/CandidatesPostResponsesContentApplicationJsonSchemaData'
required:
- data
title: Candidates_addCandidate_Response_201
ApiErrorContainer:
type: object
properties:
request:
$ref: '#/components/schemas/ApiErrorRequest'
errors:
type: array
items:
$ref: '#/components/schemas/ApiError'
title: ApiErrorContainer
securitySchemes:
deelToken:
type: http
scheme: bearer
description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n"
oauth2:
type: http
scheme: bearer
description: Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/