1. Docs
  2. API Reference
  3. List operational administrators in an Environment

List operational administrators in an Environment

GET/portal/v1/accounts/{accountSlug}/admin-assignments

One page of the unrevoked administrator grants in the Account, covering account, Environment and node scopes, each with the user holding it (user: id, names, email, avatar). Oldest first unless sorted (sort_by created or role); filters by admin_role_id and scope_type; q searches role names and the holders' names and emails. There is no person sort, since the people are platform users stored apart from the grants. Grants are not filtered by their effective window, so expired and future-dated grants are listed until someone revokes them. Requires admin_governance.view.

Authentication

Bearer TokenAuthorization

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

Path Parameters

accountSlugstring Required

The Account's slug. An unknown one answers 404.

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 role names and the holders' first names, last names and emails

max length 200

sort_byenum Optional

Sort column. Defaults to `created`, oldest grant first; `role` sorts by role name.

one of "created" · "role"

orderenum Optional

Sort direction

one of "asc" · "desc"

admin_role_idstring · uuid Optional

Only grants of this administrator role

scope_typeenum Optional

Only grants of this shape: account-wide, one Environment, or one node

one of "account" · "environment" · "node"

user_idstring · uuid Optional

Only grants held by this platform user, such as the grants a person already holds before granting them another

Responses

application/json

  • itemsAdminAssignmentRowDto[]*
  • paginationPageMetaDto*

application/json

  • errorApiErrorBodyDto*

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 to 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

AdminAssignmentRowDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/value/admin-assignments?page=0&take=0&q=value&sort_by=created&order=asc&admin_role_id=value&scope_type=account&user_id=value" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "items": [
    {
      "id": "string",
      "admin_role_id": "string",
      "user_id": "string",
      "environment_id": "string",
      "scope_type": "account",
      "application_node_id": "string",
      "effective_from": "2026-04-20T12:00:00.000Z",
      "effective_to": "2026-04-20T12:00:00.000Z",
      "revoked_at": "2026-04-20T12:00:00.000Z",
      "created_at": "2026-04-20T12:00:00.000Z",
      "updated_at": "2026-04-20T12:00:00.000Z",
      "user": {
        "id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "string",
        "avatar_url": "string"
      }
    }
  ],
  "pagination": {
    "page": 0,
    "take": 0,
    "item_count": 0,
    "page_count": 0,
    "has_previous_page": false,
    "has_next_page": false
  }
}
 Related endpoints
POSTGrant an operational administrator
DELETERevoke an operational administrator
 Was this page helpful?

Tell us how we can improve this guide.

Canopy