Get a user

GET

/portal/v1/accounts/{accountSlug}/users/{id}

Returns one dashboard member's profile plus account-membership details (account_role, membership-derived is_active, joined_at). Responds 404 when the user is not a member of this Account. Account-scoped via the Account auth guard.

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.

Path Parameters

idstring Required

Responses

application/json

dataUserResponseDto*

application/json

errorApiErrorBodyDto*

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

UserResponseDtoView all properties on this resource

Request

curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/users/value" \
  -H "Authorization: Bearer $CANOPY_TOKEN"

Response

{
  "data": {
    "id": "string",
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "name": "string",
    "avatar_url": "string",
    "is_active": false,
    "account_role": "owner",
    "email_verified": false,
    "created_at": "2026-04-20T12:00:00.000Z",
    "joined_at": "2026-04-20T12:00:00.000Z"
  }
}

GETList users in Account
GETGet Account users summary
DELETERemove user from Account
POSTActivate a user
POSTDeactivate a user

Was this page helpful?

Tell us how we can improve this guide.