Sign in
Governance Entities

Get a list of entitys

Retrieves a paginated list of entities for the given customer.

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

Path parameters

idstring required

The customer identifier (owner) the entities 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

entityTypeIdstring

Filter results to entities of a specific entity type, by the type's ID

includeArchived'true' | 'false'

Whether to include archived entities. One of: true, false

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 entity objects.

Changes

Changed in 10 of the 115 revisions of this API.1108

  • ffc977f1c07e1See the full diff
    • ○

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

      response-required-property-added

  • b876edd1a4fc5See the full diff
    • ●

      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

  • 58bb216ff8ce1See the full diff
    • ●

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

      response-property-enum-value-added

  • 808e911579272See the full diff
    • ○

      api tag Governance Entities added

      api-tag-added

    • ○

      api tag Beta - Entities removed

      api-tag-removed

  • b4e8decca997112See the full diff
    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

    • ●

      deleted the query request parameter typeRefId

      request-parameter-removed

    • ○

      added the new optional query request parameter entityTypeId

      new-optional-request-parameter

    • ○

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

      response-required-property-added

  • 3acd63d6c8612See the full diff
    • ○

      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

  • 4fa87d66426d1See the full diff
    • ●

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

      response-property-enum-value-added

  • 0dece860f6781See the full diff
    • ●

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

      response-property-enum-value-added

  • b181b166a2a51See the full diff
    • ●

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

      response-property-enum-value-added

  • 41a773d02dfd1See the full diff
    • ○

      endpoint added

      endpoint-added