1. Docs
  2. API Reference
  3. List invites

List invites

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

statusenum Optional

Filter by invite status

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

environment_idstring Optional

Filter by target Environment. Pass the literal `none` to return only directory-only invites (environment_id is null).

Responses

application/json

  • itemsIdentityInviteResponseDto[]*
  • 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

IdentityInviteResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/api/v1/identity-invites?page=0&take=0&q=value&sort_by=value&order=asc&status=pending&environment_id=value" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
{
  "items": [
    {
      "id": "string",
      "email": "string",
      "intent": "activate",
      "first_name": "string",
      "last_name": "string",
      "name": "string",
      "role_id": "string",
      "node_id": "string",
      "environment_id": "string",
      "environment_name": "string",
      "has_initial_assignment": false,
      "status": "pending",
      "expires_at": "2026-04-20T12:00:00.000Z",
      "invited_by": "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
POSTCreate an invite
GETGet invite summary
POSTBulk-create invites
POSTResend an invite
DELETERevoke an invite
 Was this page helpful?

Tell us how we can improve this guide.

Canopy