Capacity (Seats)
List Allocations
List users allocated to a tenant’s active subscription, with capacity summary and pagination.
GET
Returns the seat allocations for a tenant’s active subscription. Filter by status, paginate through results, and inspect real-time capacity utilization.
Query Parameters
The external tenant ID from your application.
Filter allocations by status. One of:
active— currently allocated users (default)removed— deallocated usersall— both active and removed
1-based page number.
Number of results per page. Maximum 100.
Authentication
Requires a secret key (Authorization: Bearer sk_live_...) or service key (x-service-key).
Response
| Field | Type | Description |
|---|---|---|
allocations | AllocationUser[] | Paginated list of allocated users |
allocations[].externalUserId | string | Your app’s user ID |
allocations[].email | string | null | User’s email |
allocations[].name | string | null | User’s display name |
allocations[].status | "active" | "removed" | Current allocation status |
allocations[].allocatedAt | string | ISO 8601 timestamp of when the seat was assigned |
allocations[].removedAt | string | null | ISO 8601 timestamp of deallocation (if removed) |
allocations[].metadata | object | Metadata stored at allocation time |
capacity.activeCount | number | Current active seat count |
capacity.capacityUnits | number | Total seat limit on the subscription |
capacity.utilizationPercentage | number | activeCount / capacityUnits × 100 |
capacity.exceeded | boolean | Whether active seats exceed the limit |
pagination.total | number | Total matching records |
pagination.page | number | Current page |
pagination.totalPages | number | Total pages |
pagination.hasNextPage | boolean | Whether a next page exists |
pagination.hasPreviousPage | boolean | Whether a previous page exists |