1. Docs
  2. API Reference
  3. List identities with their role assignments

List identities with their role assignments

GET/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/identities/with-roles

Returns a paginated list of the current Environment's identities, each enriched with its role assignments (role id/name plus the node id/name the role is held at). Filter with role_id to return only identities holding a given role, or the sentinel no_assignment to return identities with no assignments in this Environment; q searches name and email and status narrows to active or inactive. Identities with no assignments come back with an empty roles array.

Authentication

Bearer TokenAuthorization

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

Requires capability env_identities.viewDeveloper Console

View identities, invitations, and role assignments in an Environment. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Production Environments require production_identities.accessDeveloper Console

Access identities in production Environments. Applies to users only, and only in an Environment marked production: its identities are real end users. API keys and identity principals are exempt.

Query Parameters

pagenumber Optional

Page number (1-based)

min 1

takenumber Optional

Items per page (1-100, default 20)

range 1–100

qstring Optional

Search term

max length 200

sort_bystring Optional

Column to sort by. Allowed values depend on the endpoint.

orderenum Optional

Sort direction

one of "asc" · "desc"

role_idstring Optional

Filter by role ID (UUID) or "no_assignment" for unassigned identities

statusenum Optional

Filter by active/inactive status. Omit to show all.

one of "active" · "inactive"

Responses

application/json

  • itemsIdentityRowDto[]*
  • paginationPageMetaDto*

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.

403environment.production_identities_forbiddenForbidden
When it happens

The Environment is marked production and the caller is a user without production identity access.

Remediation

Manage these people in the Admin Workspace, or ask an administrator to grant the Production Support role, then retry.

Pagination

This endpoint returns a paginated collection. Use the query parameters below to page through results.

pagenumber

Page number (1-indexed). Defaults to 1.

takenumber

Items per page (1–100). Defaults to 20.

Each response includes an items array alongside a pagination object with item_count, page_count, has_previous_page, and has_next_page fields.

Returned object

IdentityRowDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/identities/with-roles?page=0&take=0&q=value&sort_by=value&order=asc&role_id=value&status=active" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "items": [
    {
      "id": "string",
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "name": "string",
      "avatar_url": "string",
      "is_active": false,
      "roles": [
        {
          "assignment_id": "string",
          "id": "string",
          "name": "string",
          "node_id": "string",
          "node_name": "string",
          "effective_from": "string",
          "effective_to": "string"
        }
      ],
      "created_at": "2026-04-20T12:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 0,
    "take": 0,
    "item_count": 0,
    "page_count": 0,
    "has_previous_page": false,
    "has_next_page": false
  }
}
 Related endpoints
GETList identities in Application
POSTCreate an identity
GETGet Application identities summary
POSTBulk-create identities
POSTRecord a bulk-import wizard completion
GETGet an identity
PATCHUpdate an identity
DELETERemove an identity
GETGet identity detail with role assignments
POSTActivate an identity
POSTDeactivate an identity
GETGet identity's role assignments
GETGet identity's effective permissions
 Was this page helpful?

Tell us how we can improve this guide.

Canopy