Get a list of entitys

Retrieves a paginated list of entities for the given customer.

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

JavaScript

JavaScript

import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const entityListResponse of client.v1Beta.customers.entities.list('id')) {
  console.log(entityListResponse.id);
}

200

{
  "data": [
    {
      "id": "user-7f3a0c1d",
      "typeId": "user",
      "metadata": {
        "email": "[e-mail]",
        "role": "admin"
      },
      "createdAt": "2026-05-18T00:00:00.000Z",
      "updatedAt": "2026-05-18T00:00:00.000Z",
      "archivedAt": null
    }
  ],
  "pagination": {
    "next": "c9b0a382-5b7d-4d32-9f62-8c4e1a7b3d9f",
    "prev": "a1d4e8f2-6c3b-4a9e-b5f7-2d8c9e0f1a3b"
  }
}

Authorizations

X-API-KEY · string · header · required

Server API Key

Headers

X-ACCOUNT-ID · string

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-ID · string

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).

Path Parameters

id · string · required

The customer identifier (owner) the entities belong to

Required string length: 1 - 255

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.@-]*$

Query Parameters

after · string<uuid>

Return items that come after this cursor

before · string<uuid>

Return items that come before this cursor

limit · integer · default: 20

Maximum number of items to return

Required range: 1 <= x <= 100

typeRefId · string

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

Required string length: 1 - 255

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$

includeArchived · enum<string>

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

Available options: true, false

Response

200

application/json

A paginated list of entity objects.

Response list object

data · Entity · object[] · required

Show child attributes

pagination · object · required

Pagination metadata including cursors for navigating through results

Show child attributes