Docs
API reference

List a job's auto-invite evaluations

GET
/api/v1/jobs/{id}/auto-invite/evaluations

What the rule decided for each report, newest first, with the values it read: the fit score, every condition it checked and the criteria of the revision that read it, and anything to look at before approving. A queued item carries matchesCurrentRule: false when the rule has since been made stricter (with noLongerMatchesReason), which dismissing the item through POST .../evaluations/dismiss resolves; nothing is dismissed automatically. Any outcome can be listed, so this is also the audit history. With outcome=queued this is the queue of candidates waiting for approval; with outcome=held it is the invites about to go out, each with its inviteAt.

Required scope: auto_invite:read (auto_invite: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

Authorization

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

Path Parameters

id*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
outcome?string

Only evaluations with this outcome. Use queued for the candidates waiting for approval.

Value in"queued""held""invited""dismissed""cancelled""no_match""skipped""failed"

Response Body

Success.

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

The evaluations 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/ID_VALUE/auto-invite/evaluations" \  -H "Authorization: Bearer $PROBB_API_KEY"
Example Response
{  "object": "list",  "data": [    {      "object": "auto_invite_evaluation",      "id": "string",      "reportId": "string",      "candidateName": "string",      "outcome": "queued",      "ruleRevision": -9007199254740991,      "currentRole": "string",      "reportCreatedAt": "2019-08-24T14:15:22Z",      "fitScore": 0,      "riskSignalCount": -9007199254740991,      "mustHaves": {        "supported": -9007199254740991,        "total": -9007199254740991,        "unmetHardConstraintCount": -9007199254740991      },      "otherInterviewOnJob": true,      "matched": [        "string"      ],      "notes": [        "string"      ],      "conditions": [        {          "id": "fit",          "result": "met",          "text": "string"        }      ],      "criteria": {        "minFitScore": 0,        "mustHaves": "any",        "whenUnknown": "queue",        "excludeIntegrityReview": true      },      "matchesCurrentRule": true,      "noLongerMatchesReason": "string",      "reason": "string",      "inviteAt": "2019-08-24T14:15:22Z",      "queuedBecause": "string",      "invitedByRule": true,      "interviewId": "string",      "createdAt": "2019-08-24T14:15:22Z",      "decidedAt": "2019-08-24T14:15:22Z"    }  ],  "hasMore": true,  "nextCursor": "string"}