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

Get invite summary

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

Responses

application/json

  • dataIdentityInvitesSummaryDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

IdentityInvitesSummaryDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/api/v1/identity-invites/summary" \
  -H "X-API-Key: $CANOPY_API_KEY"
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
POSTCreate an invite
POSTBulk-create invites
POSTResend an invite
DELETERevoke an invite
 Was this page helpful?

Tell us how we can improve this guide.

Canopy