STstiggio
Governance Entities

Get a list of entitys

Changed on

Retrieves a paginated list of entities for the given customer.

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

Request

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

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

  • ffc977f1c07eRevision changes
    • info

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

  • b876edd1a4fcRevision 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