API reference
Retrieve the organization settings
GET
Returns the organization's name, how candidate feedback behaves (candidateFeedback), the report and interview versions new work uses, and the versions it may choose, with what each costs. Any key that can read the organization can call it; it reveals nothing GET /v1/organization does not.
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*stringid*stringThe organization's ID.
name*stringThe organization's name.
billingMode*stringDecides whether credits or quotaWeight describes a run.
Value in
"credits""quota"candidateFeedback*How candidate feedback behaves for the organization. Change it with candidateFeedback on the update.
versions*The versions new reports and interviews use. Existing ones keep theirs.
available*The versions the organization may choose, as the app lists them. The assigned one is always included.
# 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/settings" \ -H "Authorization: Bearer $PROBB_API_KEY"Example Response
{ "object": "organization_settings", "id": "string", "name": "string", "billingMode": "credits", "candidateFeedback": { "enabled": true, "defaultSections": { "strengths": true, "resume": true, "interview": true, "skills": true }, "includePractice": true }, "versions": { "report": { "id": "string", "label": "string", "state": "released", "whenToUse": "string" }, "interview": { "id": "string", "label": "string", "state": "released", "whenToUse": "string", "capabilities": { "recording": true, "speakerVerification": true } } }, "available": { "report": [ { "id": "string", "label": "string", "state": "released", "whenToUse": "string", "available": true, "unavailableReason": "string", "quotaWeight": 0, "credits": 0 } ], "interview": [ { "id": "string", "label": "string", "state": "released", "whenToUse": "string", "available": true, "unavailableReason": "string", "quotaWeight": 0, "credits": 0 } ] }}