API reference
Retrieve the current API key
GET
Describes the key that authenticated the request: its name, scopes, expiry and environment. Any valid key can call this.
Any valid API key can call this endpoint.
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 key's ID. Not the secret.
name*stringThe name given when the key was created.
scopes*array<>What the key may do. x:write also allows x:read.
environment*stringtest keys work only against the developer sandbox.
Value in
"live""test"createdAt*stringWhen the key was created.
Format
date-timeexpiresAt*stringWhen the key stops working.
Format
date-timelastUsedAt*|When the key last authenticated, or null if never.
owner*Keys act for the member who created them, with what their role allows. Revoking the key, changing the member's role or removing them stops 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/api-key" \ -H "Authorization: Bearer $PROBB_API_KEY"Example Response
{ "object": "api_key", "id": "string", "name": "string", "scopes": [ "candidates:read" ], "environment": "live", "createdAt": "2019-08-24T14:15:22Z", "expiresAt": "2019-08-24T14:15:22Z", "lastUsedAt": "2019-08-24T14:15:22Z", "owner": { "id": "string", "name": "string" }}