API reference
Retrieve a file
GET
Returns the file's status. uploaded means the bytes arrived; they are verified when the file is attached to a candidate. The upload URL is never returned again.
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:
file_not_found - 422:
invalid_parameter - 429:
rate_limit_exceeded - 500:
api_error - 503:
service_unavailable
ApiKeyheader
AuthorizationBearer <probb_live_<id>_<secret>>id*stringThe file's ID.
Length
1 <= length <= 200Success.
application/json- response
object*stringid*stringThe file's ID. Pass it as resume.fileId.
fileName*stringThe file name you gave.
mimeType*stringThe file's media type.
sizeBytes*integerThe size you declared, in bytes.
Range
-9007199254740991 <= value <= 9007199254740991status*stringawaiting_upload until the file is PUT, uploaded after, attached once a candidate uses it, rejected if it is not a valid resume, expired after 24 hours unattached.
Value in
"awaiting_upload""uploaded""attached""rejected""expired"expiresAt*stringAfter this the file can no longer be attached.
Format
date-timecreatedAt*stringWhen the file was created.
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/files/ID_VALUE" \ -H "Authorization: Bearer $PROBB_API_KEY"Example Response
{ "object": "file", "id": "string", "fileName": "string", "mimeType": "string", "sizeBytes": -9007199254740991, "status": "awaiting_upload", "expiresAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z"}