Your key › Get the person behind the key

Your key

Get the person behind the key

GET/api/mePermalink

The person behind a personal key. An organisation’s key has no person (403). Changing the profile and ending sessions stay the console’s.

Permission
A personal key only: an organisation’s key gets 403
Plan
Plans that include the API: Pricing
Retry
Safe: a read changes nothing

Example request

bash
curl "https://console.brevily.com/api/me" \  -H "x-api-key: brv_ak_7Fq2Lw9xK3" \  -H "x-api-secret: $BREVILY_SECRET"

Example answer

json
{  "id": "01JC6Y8QH2M4ZK7T9VRW3XNB5D",  "email": "ada@example.com",  "name": "example",  "language": "example",  "organisationCode": "example",  "role": "OWNER",  "groups": [    "example"  ],  "hasPassword": false,  "twoFactor": false,  "recoveryCodesLeft": 1,  "passkeys": 1,  "signIns": [    "example"  ],  "theme": "system",  "analytics": false,  "emails": {},  "sessions": [    {      "id": "01JC6Y8QH2M4ZK7T9VRW3XNB5D",      "device": "example",      "method": "example",      "place": "example",      "remember": false,      "createdOn": "2026-11-05T09:41:00Z",      "lastSeenOn": "2026-11-05T09:41:00Z",      "expiresOn": "2026-11-05T09:41:00Z"    }  ],  "createdOn": "2026-11-05T09:41:00Z"}

Made-up values.

AnswerPermalink

Me

Answer fields
NameTypeDescriptionAllowed values
idstringThe person’s id.—
emailstringThe address they sign in with.—
namestringTheir name; null when none is set.or null
languagestringTheir language (en, en-GB).—
organisationCodestringTheir organisation.or null
rolestringDerived, never stored: the owner, else Admin or Billing by the system groups held, else MEMBER.OWNER, ADMIN, MEMBER
groupsstring[]The groups they sit in.—
hasPasswordbooleanThey can sign in with a password; false when they sign in through a provider only.—
twoFactorbooleanTwo-factor is on.—
recoveryCodesLeftintegerUnused recovery codes.—
passkeysintegerPasskeys registered.—
signInsstring[]The providers linked to sign them in.—
themestringThe console’s theme.system, light, dark
analyticsbooleanUsage analytics in the console: true on, false off; null when never asked.or null
emailsobjectEach optional email (by its switch’s name) and whether they get it.—
sessionsSession[]Their signed-in sessions, newest first.—
createdOndate-timeWhen the account was made.—
Fields of sessions
Fields of sessions
NameTypeDescriptionAllowed values
idstringThe session’s id: what POST /profile/sessions/{session}/revoke takes.—
devicestringThe browser and system it was opened on.—
methodstringHow it signed in ("Password + 2FA", "GitHub"); null when not recorded.or null
placestringWhere it signed in from, as the address placed it; null when unknown.or null
rememberboolean"Keep me signed in" was ticked.—
createdOndate-timeWhen it signed in.—
lastSeenOndate-timeWhen it was last used; null when not recorded.or null
expiresOndate-timeWhen it ends, the organisation’s session policy applied.—

ErrorsPermalink

Errors
Status Code When
400 VALIDATION_FAILED A field, a parameter or the body is wrong; details.fields says which.
401 UNAUTHENTICATED No key, a key that does not match, or one expired or revoked.
403 ACCESS_DENIED An organisation’s key: this call needs a personal key, which acts as its person.
404 NOT_FOUND No organisation with that code for this key, or no such record in it.
429 RATE_LIMITED Too many calls: wait Retry-After seconds.

Rate limitsPermalink

Counted with every other call of the organisation, by plan: Pricing. The answer carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset; more on rate limits.