1. Docs
  2. API Reference
  3. List setup status for every Environment in the Account

List setup status for every Environment in the Account

GET/portal/v1/accounts/{accountSlug}/setup-summaries

Authentication

  • Bearer Token Authorization

    JWT access token

Code samples

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

Responses

200 One row per (Application × Environment). `is_complete` is true when the env has ≥ 1 custom permission, ≥ 1 custom role, and ≥ 1 role-permission mapping on a custom role. Drives the env-card empty-states on the Tenant > Applications page.
{
  "items": [
    {
      "application_id": "string",
      "application_slug": "string",
      "environment_id": "string",
      "environment_slug": "string",
      "has_permissions": false,
      "has_roles": false,
      "has_role_permissions": false,
      "is_complete": false,
      "identities_count": 0
    }
  ]
}

application/json

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