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

Pinpoint Applicants API

Candidate (applicant) records.

Pinpoint Applicants API is one of 4 APIs that Pinpoint publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 3 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://{subdomain}.pinpointhq.com/api/v1.

3 operations 2 paths 7 schemas 2 GET1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://{subdomain}.pinpointhq.com/api/v1
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Pinpoint Applicants API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-KEY (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key generated in Settings API & Webhooks API Keys. Sent with every request as the X-API-KEY header. Missing or invalid keys return HTTP 401.

Paths & Operations 3

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

Applicants 3

Candidate (applicant) records.

GET
/candidates
List candidates (applicants)
listCandidates 4 params → 200401
GET
/candidates/{id}
Fetch candidate (applicant)
getCandidate 3 params → 200401404
PATCH
/candidates/{id}
Update candidate (applicant)
updateCandidate 1 param body → 200401422

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are CandidateAttributes (8 properties), Candidate (4 properties), CandidateCollection (2 properties), PaginationMeta (2 properties). Each schema is shown below with its type and property counts.

CandidateAttributes
object
8 properties
PaginationMeta
object
2 properties
CandidateSingleWrite
object
1 property
CandidateCollection
object
2 properties
CandidateSingle
object
1 property
Errors
object
1 property
Candidate
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pinpoint-applicants-api-openapi.yml Raw ↑

Other APIs Pinpoint publishes across the network.

Pinpoint Applications API
Pinpoint Comments API
Pinpoint Jobs API
Where this information came from

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