Account

Method	Path	Does
GET	/auth/me	Who the request is authenticated as
GET	/license	Your plan, its state, limits and usage

Who am I

GET /auth/me

{ "id": "00000000-0000-0000-0000-000000000000", "email": "", "role": "operator", "viaKey": true }

This is the simplest way to check that a key works. With an API key, viaKey is true and role is operator.

Plan and usage

GET /license

{
  "license": {
    "valid": true,
    "customer": "Acme Distribution",
    "edition": "growth",
    "features": [],
    "maxReaders": 20,
    "maxSites": 1,
    "state": "licensed",
    "readOnly": false,
    "daysLeft": 0
  },
  "usage": { "readers": 6, "sites": 1 },
  "knownFeatures": ["dock_doors", "multi_site", "api_access"]
}

Field
license.edition	Your plan.
license.state	licensed, expired, suspended or closed.
license.readOnly	true when writes are refused (see Subscription).
license.message	A sentence explaining the state, when there's something to explain. For example, how many days are left in a trial.
license.expiresAt	When a trial ends. Absent when there's no fixed end.
license.features	Add-ons included in your plan.
license.maxReaders	How many readers your plan allows. 0 means no limit.
usage.readers	Readers on your account now.

An integration can check readOnly before starting a batch of writes and alert someone instead of collecting a stream of 402s.

Not available to API keys

These endpoints exist but need an admin. API keys act as operators, so they get 403. Do these things in the hub under Settings:

• Users: /users
• API keys: /api-keys
• Audit log: /audit
• Billing: /billing/portal