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

Get invite summary

GET/api/v1/identity-invites/summary

Authentication

  • Bearer Token Authorization

    JWT access token

  • API Key X-API-Key

    API key for management-tier access

Code samples

cURLJavaScriptPythonGo
curl -X GET "https://api.canopy.dev/api/v1/identity-invites/summary" \
  -H "X-API-Key: $CANOPY_API_KEY"

Responses

200 Invite status counts returned
{
  "total_invites": 0,
  "pending_count": 0,
  "pending_with_role_count": 0,
  "accepted_count": 0,
  "expired_count": 0,
  "revoked_count": 0
}

application/json

  • total_invitesnumber*
  • pending_countnumber*
  • pending_with_role_countnumber*

    Subset of `pending_count` whose invites carry a role_id (invite-and-assign flow). Drives the dashboard's 'Assign Role to Identity' onboarding-step pending state — once an invite-with-role is accepted, the backend auto-creates the assignment, so we can show the assignment step as pending in the meantime.

  • accepted_countnumber*
  • expired_countnumber*
  • revoked_countnumber*
401 Invalid or expired token
403 This token is not authorized for this endpoint (wrong principal type — e.g., admin token on identity-only endpoint, or vice versa)

Returned object

On this page

Related endpoints

GETList invites
POSTCreate an invite
POSTBulk-create invites
POSTResend an invite
DELETERevoke an invite