Describe the calling key

GET
/me

What this key is, which organization and brands it reaches, and which scopes it holds. Requires no scope, so it is always safe to call first when wiring up an integration.

Authorization

BearerAuth
headerAuthorizationBearer <token>

An instance admin key from ADMIN_API_KEYS, or an organization key (elmo_…) issued from the dashboard.

Response Body

Describe the calling key

application/json
  1. response
keyType*string

admin for an instance key, organization for a dashboard-issued key.

Value in"admin""organization"
organizationId*|

The organization this key acts inside. Null for admin keys.

organizationName*string|null
scopes*array<>

Scopes this key holds. A read-write key lists both; an admin key always does.

brandIds*array<string>|

Brands the key is narrowed to, or null when it reaches every brand in its organization. Never an empty array — a restriction to no brands is rejected at creation rather than treated as no restriction.

createdAt*|
Formatdate-time
expiresAt*|

When the key stops working, if it has an expiry.

Formatdate-time
rateLimit*|

The key's configured limit — generous by design: it exists to stop a runaway loop, not to meter normal use. Enforcement is a fixed window and approximate under concurrency.

createdBy*|

The key's label, as given when it was issued. Null for admin keys.

lastUsedAt*|
Formatdate-time
curl -X GET 'https://app.elmohq.com/api/v1/me'
{  "keyType": "admin",  "organizationId": "string",  "organizationName": "string",  "scopes": [    "read"  ],  "brandIds": [    "string"  ],  "createdAt": "2019-08-24T14:15:22Z",  "expiresAt": "2019-08-24T14:15:22Z",  "rateLimit": {    "limit": 0,    "window": "minute"  },  "createdBy": "string",  "lastUsedAt": "2019-08-24T14:15:22Z"}