1. Docs
  2. API Reference
  3. List identities at a node

List identities at a node

GET/api/v1/nodes/{id}/identities

Returns a paginated list of identity role assignments effective at a node, gated by hierarchy.view on that node. The result spans the node's full lineage so inherited assignments (granted at ancestor nodes) appear alongside direct ones, with each row flagged accordingly. Supports filtering by q, role_id, access_type, status, and source_node_id, plus sorting and paging. Returns 404 when the node is not found in this Environment.

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.

Path Parameters

idstring Required

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_byenum Optional

Sort field

one of "name" · "role" · "access_type" · "created_at"

orderenum Optional

Sort order

one of "asc" · "desc"

role_idstring Optional

Filter by role ID

access_typeenum Optional

Filter by access type

one of "direct" · "inherited"

statusenum Optional

Filter by assignment status

one of "active" · "scheduled" · "expired"

source_node_idstring Optional

Filter by source node ID

Responses

application/json

  • itemsIdentityAssignmentRowDto[]*
  • paginationPageMetaDto*

application/json

  • errorApiErrorBodyDto*

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

IdentityAssignmentRowDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/api/v1/nodes/value/identities?page=0&take=0&q=value&sort_by=name&order=asc&role_id=value&access_type=direct&status=active&source_node_id=value" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
{
  "items": [
    {
      "identity": {
        "id": "string",
        "first_name": "string",
        "last_name": "string",
        "name": "string",
        "email": "string",
        "avatar_url": "string"
      },
      "role": {
        "id": "string",
        "name": "string"
      },
      "assignment": {
        "id": "string",
        "source_node_id": "string",
        "source_node_name": "string",
        "access_type": "direct",
        "effective_from": "2026-04-20T12:00:00.000Z",
        "effective_to": "2026-04-20T12:00:00.000Z",
        "status": "active",
        "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 hierarchy (scoped tree)
POSTCreate a hierarchy node
GETList the hierarchy as parent edges
GETGet a hierarchy node
PATCHUpdate a hierarchy node
DELETEDelete a hierarchy node
GETGet subtree from a node
GETGet ancestor chain for a node
GETGet direct children of a node
POSTMove (reparent) a node
GETGet identity summary for a node
 Was this page helpful?

Tell us how we can improve this guide.

Canopy