Spec0docsCLI 0.7.0

How many consumers depend on an API

The blast-radius number: how many teams and services hold a grant on this API, and how many of those grants are approved. It answers "if I change this, does anyone else care?" — the question worth asking before editing a contract.

Counts, not a roster. Who consumes what is org-governance information with its own screen, approval flow and permissions in the dashboard; restating a slice of it here would create a second, staler place to read it. A client that needs the detail should link a person to the dashboard, which this count is sized to prompt.

total counts every grant regardless of status; approved counts only those in APPROVED. A pending grant is a real consumer waiting on a decision, so it is deliberately included in the total rather than hidden.

Authorization stack:

  • scope: read:apis
  • ABAC v2: caller must be permitted to view the API resource (cross-org and cross-team isolation collapse to 404 to avoid leaking existence).

Requires scope read:apis.

GET
/api/v1/public/apis/team/{apiId}/consumers

Authorization

BearerAuth
AuthorizationBearer <token>

Bearer token. Either a Personal Access Token (pat_...) or a Service Account Token (sat_...). Issued via the Spec0 dashboard or /me/personal-access-tokens.

In: header

Path Parameters

apiId*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://app.spec0.io/api/v1/public/apis/team/497f6eca-6276-4993-bfeb-53cbbbba6f08/consumers"
{
  "total": 0,
  "approved": 0
}
{
  "error": "string",
  "message": "string"
}
{
  "status": 0,
  "title": "string",
  "detail": "string",
  "type": "string",
  "instance": "string"
}
{
  "status": 0,
  "title": "string",
  "detail": "string",
  "type": "string",
  "instance": "string"
}
Was this helpful?