API reference
Retrieve the interview reminder settings
GET
Returns when candidates who have not started their interview get a reminder: a nudge a few days after the invitation and a last call before the link expires, each at most once, sent between 09:00 and 18:00 in the organization's time zone. Reminders are on by default. Any key that can read the organization can call it.
Required scope: organization:read (organization:write also works).
Errors
- 401:
authentication_required,invalid_api_key - 403:
api_access_disabled,insufficient_scope - 429:
rate_limit_exceeded - 500:
api_error - 503:
service_unavailable
ApiKeyheader
AuthorizationBearer <probb_live_<id>_<secret>>Success.
application/json- response
object*stringnudge*The first reminder, a few days after the invitation.
lastCall*The second reminder, shortly before the link expires.
timeZone*stringThe IANA time zone (for example Europe/London) the 09:00 to 18:00 send window is read in. UTC until an admin sets it.
# 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/organization/interview-reminders" \ -H "Authorization: Bearer $PROBB_API_KEY"Example Response
{ "object": "interview_reminder_settings", "nudge": { "enabled": true, "afterDays": 1 }, "lastCall": { "enabled": true, "hoursBefore": 12 }, "timeZone": "string"}