Who the caller is
const url = 'https://example.com/v1/me';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/v1/me \ --header 'Authorization: Bearer <token>'For an org API key: its organization (tenant) and its stored role, viewer
or member; a key never acts above member.
For a user (token or browser session): the user, their language and the
organizations they belong to.
For a GitHub Actions OIDC token: the repository it was issued to.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”Caller identity
object
Kind=key: the key’s organization
Kind=key: the key’s stored role, viewer or member; a key never acts above member
Kind=user: the user ID
Kind=user
Kind=user
Kind=user: their language, or null to follow the browser
Kind=github: owner/name
Kind=user: what this server has switched on, so the web app shows only what works
object
The webhook endpoint routes are available
Kind=user: memberships, sorted by org
object
Viewer reads; member also submits reports; admin also manages keys and members; owner also billing
Only active organizations can be used; the others answer 403 org.suspended
Example
{ "kind": "key", "role": "viewer", "locale": "en", "orgs": [ { "role": "viewer", "status": "active" } ]}Missing or invalid credentials
Over the operation’s rate-limit budget (x-affectra-budget): code request.rateLimited with params.budget. Wait Retry-After seconds before trying again.
Every error answer, Content-Type
application/problem+json. The web app and integrations translate code; detail is English,
for people reading curl output or CI logs, and may change wording at
any time. Match on code, never on detail.
object
The HTTP status
Stable error codes. A code is never renamed; new ones may be added, so
a client falls back to detail for a code it doesn’t know. Another
organization’s object answers notFound, the same as a missing one.
What went wrong
Values the code’s message needs, e.g. {“field”: “version”}. Only values the caller sent or may see. Empty when the message needs none.
object
Example
{ "code": "notFound"}Headers
Section titled “Headers”Seconds until a request would be allowed again, at least 1