1. Docs
  2. API Reference
  3. Get invite summary

Get invite summary

GET/portal/v1/accounts/{accountSlug}/identity-invites/summary

Returns invite counts for the active Environment grouped by status: total_invites, pending_count, accepted_count, expired_count, and revoked_count, plus pending_with_role_count for pending invites that carry an initial role assignment. Counts span the entire Environment, not a single page.

Authentication

Bearer TokenAuthorization

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

Requires capability identities.viewIdentities

View end-user identities across the account. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Responses

application/json

  • dataIdentityInvitesSummaryDto*

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.

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.

Returned object

IdentityInvitesSummaryDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/identity-invites/summary" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "data": {
    "total_invites": 0,
    "pending_count": 0,
    "pending_with_role_count": 0,
    "accepted_count": 0,
    "expired_count": 0,
    "revoked_count": 0
  }
}
 Related endpoints
GETList invites
POSTInvite an identity at the Account tier
POSTResend an invite
DELETERevoke an invite
 Was this page helpful?

Tell us how we can improve this guide.

Canopy