Skip to main content
GET
/
api
/
v1-beta
/
customers
/
{id}
/
assignments
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 assignmentListResponse of client.v1Beta.customers.assignments.list('id')) {
  console.log(assignmentListResponse.id);
}
{
  "data": [
    {
      "id": "6f6b9c39-3a14-4a5e-9c6c-2a4f8d8d2f3f",
      "entityId": "workspace-001",
      "featureId": "feature-compute-minutes",
      "currencyId": "example-external-id",
      "scopeEntityIds": [],
      "parentId": null,
      "usageLimit": 1000,
      "cadence": "MONTH",
      "createdAt": "2026-05-18T10:00:00.000Z",
      "updatedAt": "2026-05-18T10:00:00.000Z"
    },
    {
      "id": "8d3a9b71-c41b-4d22-a17b-93e6f6d3b201",
      "entityId": "workspace-002",
      "featureId": "example-external-id",
      "currencyId": "cred-type-tokens",
      "scopeEntityIds": [
        "user-1"
      ],
      "parentId": "workspace-001",
      "usageLimit": 2000,
      "cadence": "MONTH",
      "createdAt": "2026-05-18T10:00:00.000Z",
      "updatedAt": "2026-05-18T10:00:00.000Z"
    }
  ],
  "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 assignments 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
​
entityId
string

Filter assignments to a specific entity refId

Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$
​
capabilityId
string

Filter assignments to a specific capability refId

Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$

Response

A paginated list of assignment objects.

Response list object

​
data
Assignment · object[]
required
​
pagination
object
required

Pagination metadata including cursors for navigating through results