API reference
Retrieve a candidate
GET
Required scope: candidates:read (candidates:write also works).
Errors
- 400:
unknown_field - 401:
authentication_required,invalid_api_key - 403:
api_access_disabled,insufficient_scope - 404:
candidate_not_found - 422:
invalid_parameter - 429:
rate_limit_exceeded - 500:
api_error - 503:
service_unavailable
ApiKeyheader
AuthorizationBearer <probb_live_<id>_<secret>>id*stringThe candidate's ID.
Length
1 <= length <= 200Success.
application/json- response
object*stringid*stringThe candidate's ID. The same ID the app uses.
externalId*|Your own ID for the candidate, unique within the organization.
name*|The candidate's full name.
email*|The candidate's email address.
linkedinUrl*|The candidate's LinkedIn profile URL.
currentRole*|The candidate's current role or headline.
location*|Where the candidate is based.
resumeStatus*stringnone without a resume, processing while Probb reads it, ready once it has been read, failed if it could not be read.
Value in
"none""processing""ready""failed"resumeError*|Why the resume could not be read, when resumeStatus is failed.
revision*stringChanges on every update. Send it as If-Match to avoid overwriting newer changes.
createdAt*stringWhen the candidate was created.
Format
date-timeupdatedAt*stringWhen the candidate last changed.
Format
date-time# Set PROBB_URL and PROBB_API_KEY. Replace any *_VALUE placeholder and any example ID (such as job_example) with a real one.curl --fail-with-body -X GET "$PROBB_URL/api/v1/candidates/ID_VALUE" \ -H "Authorization: Bearer $PROBB_API_KEY"Example Response
{ "object": "candidate", "id": "string", "externalId": "string", "name": "string", "email": "string", "linkedinUrl": "string", "currentRole": "string", "location": "string", "resumeStatus": "none", "resumeError": "string", "revision": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}