1. Docs
  2. API Reference
  3. Get Account users summary

Get Account users summary

GET/portal/v1/accounts/{accountSlug}/users/summary

Authentication

  • Bearer Token Authorization

    JWT access token

Code samples

cURLJavaScriptPythonGo
curl -X GET "https://api.canopy.dev/portal/v1/accounts/{accountSlug}/users/summary" \
  -H "Authorization: Bearer $CANOPY_TOKEN"

Responses

200 User counts returned (total, assigned, unassigned)
{
  "total_users": 0,
  "active_count": 0,
  "inactive_count": 0
}

application/json

  • total_usersnumber*
  • active_countnumber*
  • inactive_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 users in Account
GETGet a user
DELETERemove user from Account
POSTActivate a user
POSTDeactivate a user