Governance Assignments

Get a list of assignments

Changed on

Returns a cursor-paginated list of capability assignments for the given customer. An assignment ties an entity to a capability with a usage limit and reset cadence.

get/api/v1-beta/customers/{id}/assignments

Request

  • Base URL
    https://api.stigg.io
  • URL
    https://api.stigg.io/api/v1-beta/customers/{id}/assignments
  • Auth
    API key in header X-API-KEY

Path parameters

idstring required

The customer identifier (owner) the assignments belong to

Query parameters

afterstring uuid

Return items that come after this cursor

beforestring uuid

Return items that come before this cursor

limitinteger

Maximum number of items to return

entityIdstring

Filter assignments to a specific entity ID

featureIdstring

Filter assignments to a specific feature, by its ID. Mutually exclusive with currencyId.

currencyIdstring

Filter assignments to a specific currency, by its ID. Mutually exclusive with featureId.

Headers

X-ACCOUNT-IDstring

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-IDstring

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Response

A paginated list of assignment objects.

Changes

    • warning

      added the new CreditOveragePriceCurrencyNotFound enum value to the response property for the response status

    • warning

      added the new InvalidCreditOverageBillingModel enum value to the response property for the response status

    • warning

      added the new InvoicePreviewNotAvailableForDraftContract enum value to the response property for the response status

    • warning

      added the new OveragePriceNotSupportedOnAddon enum value to the response property for the response status

    • warning

      added the new OveragePriceRequiresUsageLimit enum value to the response property for the response status

    • warning

      added the new GovernanceNotEnabled enum value to the response property for the response status