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

Merge subpackage_candidates API

The subpackage_candidates API from Merge — 5 operation(s) for subpackage_candidates.

Merge subpackage_candidates API is one of 118 APIs that Merge publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 21 JSON Schema definitions.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a support channel, and 21 JSON Schemas.

This API exposes 7 operations across 5 paths, and defines 30 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 3 base URLs: https://api.merge.dev/api, https://api-eu.merge.dev/api, https://api-ap.merge.dev/api.

7 operations 5 paths 30 schemas 4 GET1 PATCH2 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.merge.dev/api/hris/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Merge subpackage_candidates API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (tokenAuth).

  • tokenAuth — Token-based authentication with required prefix "Bearer"

Paths & Operations 7

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

subpackage_candidates 7
GET
/ats/v1/candidates
List
list 17 params → 200
POST
/ats/v1/candidates
Create
create 4 params body → 201
GET
/ats/v1/candidates/{id}
Retrieve
retrieve 6 params → 200
PATCH
/ats/v1/candidates/{id}
Partial Update
partial-update 5 params body → 200
POST
/ats/v1/candidates/ignore/{model_id}
Ignore Create
ignore-create 3 params body → 200
GET
/ats/v1/candidates/meta/patch/{id}
Meta Patch Retrieve
meta-patch-retrieve 3 params → 200
GET
/ats/v1/candidates/meta/post
Meta Post Retrieve
meta-post-retrieve 2 params → 200

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are Candidate (23 properties), CandidateRequest (17 properties), PatchedCandidateRequest (17 properties), WarningValidationProblem (7 properties). Each schema is shown below with its type and property counts.

UrlRequest
object
The Url Object Description The Url object is used to represent hyperlinks associated with the parent model. Usage Example Fetch from the GET Candidate endpoint…
4 properties
ValidationProblemSource
object
1 property 1 required
EmailAddress
object
The EmailAddress Object Description The EmailAddress object is used to represent a candidate's email address. Usage Example Fetch from the GET Candidate endpoi…
5 properties
PhoneNumberTypeEnum
string
CandidatesGetParametersExpandSchemaItems
string
PhoneNumber
object
The PhoneNumber Object Description The PhoneNumber object is used to represent a candidate's phone number. Usage Example Fetch from the GET Candidate endpoint…
5 properties
CandidateRequest
object
The Candidate Object Description The Candidate object is used to represent profile information about a given Candidate. Because it is specific to a Candidate,…
17 properties
DebugModelLogSummary
object
3 properties 3 required
PatchedCandidateRequest
object
The Candidate Object Description The Candidate object is used to represent profile information about a given Candidate. Because it is specific to a Candidate,…
17 properties
EmailAddressTypeEnum
string
PaginatedCandidateList
object
3 properties
LinkedAccountStatus
object
2 properties 2 required
Candidate
object
The Candidate Object Description The Candidate object is used to represent profile information about a given Candidate. Because it is specific to a Candidate,…
23 properties
CandidateResponse
object
4 properties 3 required
candidates_ignoreCreate_Response_200
object
Empty response body
ReasonEnum
string
MetaResponse
object
5 properties 3 required
PatchedCandidateEndpointRequest
object
2 properties 2 required
CandidateFieldMappings
object
2 properties
RemoteData
object
The RemoteData Object Description The RemoteData object is used to represent the full data pulled from the third-party API for an object. Usage Example TODO
2 properties 1 required
EmailAddressRequest
object
The EmailAddress Object Description The EmailAddress object is used to represent a candidate's email address. Usage Example Fetch from the GET Candidate endpoi…
4 properties
CandidatesIdGetParametersExpandSchemaItems
string
DebugModeLog
object
3 properties 3 required
UrlTypeEnum
string
Url
object
The Url Object Description The Url object is used to represent hyperlinks associated with the parent model. Usage Example Fetch from the GET Candidate endpoint…
5 properties
CandidateEndpointRequest
object
2 properties 2 required
PhoneNumberRequest
object
The PhoneNumber Object Description The PhoneNumber object is used to represent a candidate's phone number. Usage Example Fetch from the GET Candidate endpoint…
4 properties
WarningValidationProblem
object
7 properties 3 required
ErrorValidationProblem
object
7 properties 3 required
IgnoreCommonModelRequest
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

merge-subpackage-candidates-api-openapi.yml Raw ↑

Other APIs Merge publishes across the network.

Merge Default API
Merge subpackage_accessKeys API
Merge subpackage_accountDetails API
Merge subpackage_accountingPeriods API
Merge subpackage_accounts API
Merge subpackage_accountToken API
Merge subpackage_activities API
Merge subpackage_addresses API
Merge subpackage_applicationCredentials API
Merge subpackage_applications API
Merge subpackage_articles API
Where this information came from

This is an independent, third-party profile of Merge subpackage_candidates 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.