1. Docs
  2. API Reference
  3. List platform-admin members of the Account

List platform-admin members of the Account

GET/portal/v1/accounts/{accountSlug}/members

Returns every AccountMember (the human admins/owners of the Account), as an unpaginated { items } list. Account-scoped and authorized by account membership; members have access across every Application in the Account. Adding members happens through the user-invite flow, not here.

Authentication

Bearer TokenAuthorization

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

Requires capability administrators.viewGovernance

View administrators and their access. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Responses

application/json

  • itemsAccountMemberResponseDto[]*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on.

403account.capability_requiredForbidden
When it happens

The signed-in user's administrator roles do not grant the capability this endpoint requires.

Remediation

Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.

Returned object

AccountMemberResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/members" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "items": [
    {
      "user_id": "string",
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "avatar_url": "string",
      "account_role": "string",
      "joined_at": "2026-04-20T12:00:00.000Z"
    }
  ]
}
 Related endpoints
DELETERemove a platform admin from the Account
 Was this page helpful?

Tell us how we can improve this guide.

Canopy