Governance Assignments

Get a list of assignments

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

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

Changed in 13 of the 115 revisions of this API.71018

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

    • api tag Governance Assignments added

      api-tag-added

    • api tag Beta - Assignments removed

      api-tag-removed

    • deleted the query request parameter capabilityId

      request-parameter-removed

    • added the new optional query request parameter currencyId

      new-optional-request-parameter

    • added the new optional query request parameter featureId

      new-optional-request-parameter

    • removed the MONTH enum value from the // response property for the response status

      response-property-enum-value-removed

    • the // response's property pattern ^(?:P[1-9]\d*[YMWD]|PT[1-9]\d*[HMS])$ was added for the status

      response-property-pattern-added

    • the response property // became nullable for the status

      response-property-became-nullable

  • de96c0c4633a55See the full diff
    • the // response property's minLength was decreased from 1 to 0 for the response status

      response-property-min-length-decreased

    • the // response property's minLength was decreased from 1 to 0 for the response status

      response-property-min-length-decreased

    • the // response property's minLength was decreased from 1 to 0 for the response status

      response-property-min-length-decreased

    • the // response property's minLength was decreased from 1 to 0 for the response status

      response-property-min-length-decreased

    • the /// response property's minLength was decreased from 1 to 0 for the response status

      response-property-min-length-decreased

    • the // response's property pattern ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$ was removed for the status

      response-property-pattern-removed

    • the // response's property pattern ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$ was removed for the status

      response-property-pattern-removed

    • the // response's property pattern ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$ was removed for the status

      response-property-pattern-removed

    • the // response's property pattern ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$ was removed for the status

      response-property-pattern-removed

    • the /// response's property pattern ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$ was removed for the status

      response-property-pattern-removed

  • 2ecdbf877f1214See the full diff
    • removed the required property // from the response with the status

      response-required-property-removed

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the required property // to the response with the status

      response-required-property-added

    • added the required property // to the response with the status

      response-required-property-added

    • added the new optional header request parameter X-ACCOUNT-ID

      new-optional-request-parameter

    • added the new optional header request parameter X-ENVIRONMENT-ID

      new-optional-request-parameter

    • added the new PricingModelNotSupportedByBillingIntegration enum value to the response property for the response status

      response-property-enum-value-added