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

Get the current Account

GET/portal/v1/accounts/{accountSlug}

Returns the current Account's profile — id, name, slug, settings, plan, and the optimistic-lock version. Account scope comes from :accountSlug resolved by AccountAuthGuard; the caller must be a member. Pass the returned version back as the If-Match header on a subsequent update. Returns 404 if the Account does not exist or has been soft-deleted.

Authentication

Bearer TokenAuthorization

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

Path Parameters

accountSlugstring Required

The Account's slug. An unknown one answers 404.

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/portal/v1/accounts/value" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
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
DELETEDelete the Account (owner only)
GETGet the Account's hosted-page settings
PATCHUpdate the Account's hosted-page settings
GETGet the Account's policy for its administrators' second factor
PATCHUpdate the Account's policy for its administrators' second factor
 Was this page helpful?

Tell us how we can improve this guide.

Canopy