1. Docs
  2. API Reference
  3. List invites

List invites

GET/portal/v1/accounts/{accountSlug}/user-invites

Returns a paginated list of identity invites for the active Application, scoped to the current Environment. Each row carries the invite's email, intent, optional initial role/node assignment, and a computed status (pending, accepted, expired, or revoked). Use the query parameters below to page, filter by status, and search by email or name.

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

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 invitee names and emails

max length 200

sort_byenum Optional

Sort column. Defaults to `created`, newest first.

one of "name" · "email" · "created"

orderenum Optional

Sort direction

one of "asc" · "desc"

statusenum Optional

Filter by invite status

one of "pending" · "accepted" · "revoked" · "expired"

Responses

application/json

  • itemsUserInviteResponseDto[]*
  • paginationPageMetaDto*

application/json

  • errorApiErrorBodyDto*

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, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs.

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.

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

UserInviteResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/value/user-invites?page=0&take=0&q=value&sort_by=name&order=asc&status=pending" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "items": [
    {
      "id": "string",
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "name": "string",
      "status": "pending",
      "expires_at": "2026-04-20T12:00:00.000Z",
      "invited_by": "string",
      "created_at": "2026-04-20T12:00:00.000Z",
      "is_administrator_invite": false,
      "admin_role_id": "string",
      "environment_id": "string",
      "scope_type": "account",
      "application_node_id": "string"
    }
  ],
  "pagination": {
    "page": 0,
    "take": 0,
    "item_count": 0,
    "page_count": 0,
    "has_previous_page": false,
    "has_next_page": false
  }
}
 Related endpoints
POSTCreate an invite
GETGet invite summary
POSTResend an invite
PATCHChange the role a pending invite grants
DELETERevoke an invite
 Was this page helpful?

Tell us how we can improve this guide.

Canopy