---
title: "Get a list of entitys"
method: GET
path: "/api/v1-beta/customers/{id}/entities"
tags: ["Governance Entities"]
---

# Get a list of entitys

`GET /api/v1-beta/customers/{id}/entities`

Retrieves a paginated list of entities for the given customer.

## Path parameters

- `id` string, required

## Query parameters

- `after` string, uuid
- `before` string, uuid
- `limit` integer
- `entityTypeId` string
- `includeArchived` 'true' | 'false'

## Headers

- `X-ACCOUNT-ID` string
- `X-ENVIRONMENT-ID` string

## Response `200`

A paginated list of entity objects.

- EntityListResponseDto — Response list object
  - `data` object[], required
    - `id` string, required — The unique identifier for the entity
    - `displayName` string, nullable, required — Human-readable name for the entity, or null when none is set — in which case clients display the entity ID
    - `entityTypeId` string, required — The entity type identifier this entity instantiates
    - `metadata` object, required — Free-form key/value metadata attached to the entity
    - `createdAt` string, date-time, required — Timestamp of when the record was created
    - `updatedAt` string, date-time, required — Timestamp of when the record was last updated
    - `archivedAt` string, date-time, nullable, required — Timestamp of when the record was deleted
  - `pagination` object, required — Pagination metadata including cursors for navigating through results
    - `next` string, uuid, nullable, required — Cursor for fetching the next page of results, or null if no additional pages exist
    - `prev` string, uuid, nullable, required — Cursor for fetching the previous page of results, or null if at the beginning

## Other responses

- `400` — bad request.
- `401` — User is not authenticated.
- `403` — User is not allowed to access this resource.
- `429` — Too many requests.

---

[API](https://skmtc.net/stiggio/apis/stigg-api.md) · [All operations](https://skmtc.net/stiggio/apis/stigg-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stiggio/stigg-api/revisions/3e2c8cfcd035/schema)