1. Docs
  2. API Reference
  3. Get the current Account

Get the current Account

GET/api/v1/account

Returns the Account's profile: id, name, slug, settings, plan, the optimistic-lock version, and delete_grace_days. Any account API key of the Account, or any of its administrators, may read it; no scope is needed, because the key already belongs to the Account. Pass the returned version back as If-Match on an update.

Authentication

Bearer TokenAuthorization Option A

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Responses

application/json

  • dataAccountResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

AccountResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/api/v1/account" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
{
  "data": {
    "id": "string",
    "name": "string",
    "slug": "string",
    "settings": {},
    "plan": "string",
    "version": 0,
    "created_at": "2026-04-20T12:00:00.000Z",
    "updated_at": "2026-04-20T12:00:00.000Z",
    "delete_grace_days": 0
  }
}
 Related endpoints
PATCHUpdate the Account name or settings
 Was this page helpful?

Tell us how we can improve this guide.

Canopy