API reference
Retrieve a job
GET
Includes pipeline counts: reports, interviews and candidates by hiring decision.
Required scope: jobs:read (jobs:write also works).
Errors
- 400:
unknown_field - 401:
authentication_required,invalid_api_key - 403:
api_access_disabled,insufficient_scope - 404:
job_not_found - 422:
invalid_parameter - 429:
rate_limit_exceeded - 500:
api_error - 503:
service_unavailable
ApiKeyheader
AuthorizationBearer <probb_live_<id>_<secret>>id*stringThe job's ID.
Length
1 <= length <= 200Success.
application/json- response
object*stringid*stringThe job's ID. The same ID the app uses.
externalId*|Your own ID for the job, unique within the organization.
title*|The job title.
description*stringThe full job description text.
company*|The hiring company.
team*|The hiring team or department.
location*|Where the job is based.
level*|The seniority level, for example Senior.
employmentType*|How the person is employed.
status*stringclosed jobs accept no new reports or interviews.
Value in
"open""closed"closedAt*|When the job was closed.
closeReason*|Why the job was closed, when it was closed with a reason.
revision*stringChanges on every update. Send it as If-Match to avoid overwriting newer changes.
createdAt*stringWhen the job was created.
Format
date-timeupdatedAt*stringWhen the job last changed.
Format
date-timecounts*Pipeline totals. Included when retrieving one job.
# 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/jobs/ID_VALUE" \ -H "Authorization: Bearer $PROBB_API_KEY"Example Response
{ "object": "job", "id": "string", "externalId": "string", "title": "string", "description": "string", "company": "string", "team": "string", "location": "string", "level": "string", "employmentType": "full_time", "status": "open", "closedAt": "2019-08-24T14:15:22Z", "closeReason": "filled", "revision": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "counts": { "reports": -9007199254740991, "interviews": -9007199254740991, "decisions": { "advance": -9007199254740991, "hold": -9007199254740991, "not_progressing": -9007199254740991, "hired": -9007199254740991 } }}