API reference
Download a candidate's resume
GET
Returns a short-lived signed link (ten minutes) to the resume file. Resumes given as plain text have no file to download.
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,resume_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*stringurl*stringA signed link to the resume file.
fileName*stringThe original file name.
expiresAt*stringAfter this the link stops working.
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/resume" \ -H "Authorization: Bearer $PROBB_API_KEY"Example Response
{ "object": "resume_download", "url": "string", "fileName": "string", "expiresAt": "2019-08-24T14:15:22Z"}