API reference
API keys
The API key itself: what it may do.
Retrieve the API key
get
/api-keys/selfAny API key
The API key the request is made with: its name, what it may do and when it expires.
Returns 200
iduuidnamestring- What the key may do.
scopesarray of enumOne ofjobs:readjobs:writecandidates:readcandidates:writeapplications:readapplications:write - Null never expires.
expires_atdatetimenullable
Errors
- 401The key is wrong, expired or revoked (api_key_required when missing)
invalid_api_key
curl "https://api.hirehappy.io/v1/api-keys/self" \
-H "Authorization: Bearer $HIREHAPPY_API_KEY"{
"id": "5e1d9a47-2c3b-4f80-8d6e-7a9b0c1d2e3f",
"name": "Careers site",
"scopes": [
"jobs:read",
"applications:read",
"applications:write"
],
"expires_at": null
}