Docs
API reference

List a job's candidate feedback

GET
/api/v1/jobs/{jobId}/candidate-kits

One summary per candidate of the job that has candidate feedback, most recently changed first: the stage (draft, copied, sending, sent, failed, opened, expired or revoked), the revision, how it was released, the email's delivery state, whether the candidate has an address Probb can send to, whether the draft has changes the candidate has not been sent, and how many wording warnings the candidate would read. It carries no wording and no address. Candidates with no feedback are not listed. A job lists at most its 500 most recently changed. Use it to choose whom to draft for or send to with the bulk endpoints. Answers job_not_found for a job outside your organization.

Required scope: reports:read (reports:write also works).

Errors

  • 400: invalid_cursor, 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

Authorization

ApiKey
headerAuthorizationBearer <probb_live_<id>_<secret>>

Path Parameters

jobId*string

The job's ID.

Length1 <= length <= 200

Query Parameters

limit?integer

Page size, 1 to 100. Defaults to 25.

Range1 <= value <= 100
Default25
cursor?string

The nextCursor from the previous page.

Length1 <= length <= 2048

Response Body

Success.

application/json
  1. response
object*string
data*array<>

The candidate feedback summaries on this page.

hasMore*boolean

Whether another page follows.

nextCursor*|

Pass as cursor to fetch the next page, or null at the end.

Example Request
# 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/JOB_ID_VALUE/candidate-kits" \  -H "Authorization: Bearer $PROBB_API_KEY"
Example Response
{  "object": "list",  "data": [    {      "object": "candidate_kit_summary",      "candidateKitId": "string",      "reportId": "string",      "candidateId": "string",      "status": "draft",      "stage": "draft",      "revision": -9007199254740991,      "channel": "email",      "delivery": "not_requested",      "hasEmail": true,      "hasUnsentChanges": true,      "releaseWarningCount": -9007199254740991,      "releasedAt": "2019-08-24T14:15:22Z",      "firstViewedAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "hasMore": true,  "nextCursor": "string"}