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

List identities with their role assignments

GET/api/v1/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 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.

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*

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/api/v1/identities/with-roles?page=0&take=0&q=value&sort_by=value&order=asc&role_id=value&status=active" \
  -H "X-API-Key: $CANOPY_API_KEY"
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
GETGet an identity
PATCHUpdate an identity
DELETERemove an identity
GETGet identity detail with role assignments
POSTActivate an identity
POSTDeactivate an identity
POSTSet an identity's password (admin)
POSTForce a password reset for an identity (admin)
POSTRevoke all of an identity's sessions (admin)
GETGet MFA enrollment summary for an identity
POSTForce-reset an identity's MFA — admin recovery action
GETRead an identity's auth state for backend decisioning
POSTMark an identity's email verified (admin)
GETGet identity's role assignments
GETGet identity's effective permissions
GETGet where an identity holds each permission
 Was this page helpful?

Tell us how we can improve this guide.

Canopy