Skip to content
Indiana
Dashboard
Docs
Browse docs / Read seats

Read seats

POST/api/v1/seats/list

Read purchased capacity, member assignments and available seats.

API v1Updated

Make the request

Read purchased capacity, member assignments and available seats.

Credential
Server API key only. Call from your trusted backend.
Permission
customers:read
Set the base URL and App ID from SDK setup. These examples use placeholders and do not execute requests. Never put a server key in browser code.
request.shShell
curl -X POST "$INDIANA_BASE_URL/api/v1/seats/list" \  -H "Authorization: Bearer $INDIANA_SECRET_KEY" \  -H "X-Indiana-Project: $INDIANA_PROJECT_ID" \  -H "X-Indiana-Protocol: 0.5" \  -H "X-Indiana-Environment: sandbox" \  -H "Content-Type: application/json" \  -d '{  "customerId": "00000000-0000-4000-8000-000000000001"}'

The response tab lists field types, not an example payload. Actual values depend on customer state.

Request parameters

JSON body

customerIduuidRequired

Indiana customer ID mapped from a verified identity on the server. Omit for customer-token calls, which use the token-bound customer.

Response fields

Successful responses include requestId and scope. Use the actual business status or accepted field to determine the result. Optional fields are omitted when unavailable.

HTTP 200 · application/json

requestIduuidRequired

Server-generated HTTP request UUID. Include it when reporting a failed request.

scopeobjectRequired

The App and environment of this response. Headers only verify scope; they cannot switch key scope.

Show child fields
projectIdstringRequired

App ID bound to the credential.

minLength: 1

environmentenumRequired

Separate data scope: sandbox or live.

Show allowed values

"sandbox""live"

seatsobjectRequired

The seats value for this operation. Its accepted type and constraints are listed above and below.

Show child fields
customerIduuidRequired

Indiana customer ID mapped from a verified identity on the server. Omit for customer-token calls, which use the token-bound customer.

licensesarrayRequired

The licenses value for this operation. Its accepted type and constraints are listed above and below.

maxItems: 2000

Show child fields
iduuidRequired

The id value for this operation. Its accepted type and constraints are listed above and below.

linkIduuidRequired

The linkId value for this operation. Its accepted type and constraints are listed above and below.

parentobjectRequired

The parent value for this operation. Its accepted type and constraints are listed above and below.

Show child fields
customerProductIduuidRequired

The customerProductId value for this operation. Its accepted type and constraints are listed above and below.

statusenumRequired

The status value for this operation. Its accepted type and constraints are listed above and below.

Show allowed values

"active""past_due"

productobjectRequired

The product value for this operation. Its accepted type and constraints are listed above and below.

productobjectRequired

The product value for this operation. Its accepted type and constraints are listed above and below.

Show child fields
internalIduuidRequired

The internalId value for this operation. Its accepted type and constraints are listed above and below.

idstringRequired

The id value for this operation. Its accepted type and constraints are listed above and below.

namestring | nullRequired

Display name of the customer or object; not an identity key.

versionintegerRequired

The version value for this operation. Its accepted type and constraints are listed above and below.

max: 9007199254740991

planLicenseobject | nullRequired

The planLicense value for this operation. Its accepted type and constraints are listed above and below.

Show child fields
iduuidRequired

The id value for this operation. Its accepted type and constraints are listed above and below.

prepaidOnlybooleanRequired

The prepaidOnly value for this operation. Its accepted type and constraints are listed above and below.

isCustombooleanRequired

The isCustom value for this operation. Its accepted type and constraints are listed above and below.

grantedintegerRequired

The granted value for this operation. Its accepted type and constraints are listed above and below.

min: 0 · max: 9007199254740991

includedintegerRequired

The included value for this operation. Its accepted type and constraints are listed above and below.

min: 0 · max: 9007199254740991

paidQuantityintegerRequired

The paidQuantity value for this operation. Its accepted type and constraints are listed above and below.

min: 0 · max: 9007199254740991

usageintegerRequired

The usage value for this operation. Its accepted type and constraints are listed above and below.

min: 0 · max: 9007199254740991

remainingintegerRequired

Remaining allowance at evaluation time. It is not reserved and does not guarantee later consumption.

min: 0 · max: 9007199254740991

createdAtdate-timeRequired

ISO 8601 UTC time when the record was created.

assignmentsarrayRequired

The assignments value for this operation. Its accepted type and constraints are listed above and below.

maxItems: 10000

Show child fields
iduuidRequired

The id value for this operation. Its accepted type and constraints are listed above and below.

linkIduuidRequired

The linkId value for this operation. Its accepted type and constraints are listed above and below.

statusenumRequired

The status value for this operation. Its accepted type and constraints are listed above and below.

Show allowed values

"active""past_due"

productobjectRequired

The product value for this operation. Its accepted type and constraints are listed above and below.

Show child fields
internalIduuidRequired

The internalId value for this operation. Its accepted type and constraints are listed above and below.

idstringRequired

The id value for this operation. Its accepted type and constraints are listed above and below.

namestring | nullRequired

Display name of the customer or object; not an identity key.

versionintegerRequired

The version value for this operation. Its accepted type and constraints are listed above and below.

max: 9007199254740991

entityobject | nullRequired

The entity value for this operation. Its accepted type and constraints are listed above and below.

Show child fields
internalIduuidRequired

The internalId value for this operation. Its accepted type and constraints are listed above and below.

idstring | nullRequired

The id value for this operation. Its accepted type and constraints are listed above and below.

namestring | nullRequired

Display name of the customer or object; not an identity key.

beneficiaryobject | nullRequired

The beneficiary value for this operation. Its accepted type and constraints are listed above and below.

Show child fields
internalIduuidRequired

The internalId value for this operation. Its accepted type and constraints are listed above and below.

idstring | nullRequired

The id value for this operation. Its accepted type and constraints are listed above and below.

namestring | nullRequired

Display name of the customer or object; not an identity key.

startedAtdate-time | nullRequired

The startedAt value for this operation. Its accepted type and constraints are listed above and below.

endedAtdate-time | nullRequired

The endedAt value for this operation. Its accepted type and constraints are listed above and below.

limitedbooleanRequired

The limited value for this operation. Its accepted type and constraints are listed above and below.

Handle errors

Common failures
CodeRecovery
UNAUTHENTICATEDVerify the key or refresh the expired customer token once.
FORBIDDENCheck current key permissions and customer access.
INVALID_REQUESTCheck field types, UUIDs, decimal strings and mutually exclusive fields.
SCOPE_MISMATCHUse the App and environment bound to the credential.

Common failures

  • UNAUTHENTICATED

    Recovery
    Verify the key or refresh the expired customer token once.

  • FORBIDDEN

    Recovery
    Check current key permissions and customer access.

  • INVALID_REQUEST

    Recovery
    Check field types, UUIDs, decimal strings and mutually exclusive fields.

  • SCOPE_MISMATCH

    Recovery
    Use the App and environment bound to the credential.

Related:All request and error conventions·Back to endpoint index