Skip to content
Indiana
Dashboard
Docs
Browse docs / List standalone balance grants

List standalone balance grants

POST/api/v1/balances/grants/list

Read bounded pages of grant rules and available, held and spent amounts, including Entity-specific grants.

SDK 0.0.1Updated

Make the request

Read bounded pages of grant rules and available, held and spent amounts, including Entity-specific grants.

Credential
Server API key only. Call from your trusted backend.
Permission
credits: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 "$GROOVE_BASE_URL/api/v1/balances/grants/list" \  -H "Authorization: Bearer $GROOVE_SECRET_KEY" \  -H "X-Groove-Project: $GROOVE_PROJECT_ID" \  -H "X-Groove-Environment: sandbox" \  -H "Content-Type: application/json" \  -d '{  "customerId": "00000000-0000-4000-8000-000000000001",  "after": null,  "limit": 50}'

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.

afteruuid | nullRequired

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

limitintegerRequired

Maximum records per page, subject to the contract limit.

min: 1 · max: 100

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"

grantsobjectRequired

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

Show child fields
rowsarrayRequired

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

maxItems: 100

Show child fields
iduuidRequired

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

entitlementVersionIduuidRequired

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

entityIduuid | nullRequired

Entity ID within the current customer scope, for configured entity and license features.

namestringRequired

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

amountobject | nullRequired

Credit or ledger amount, using the field’s decimal-string or integer type.

resetobject | nullRequired

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

Show child fields
intervalenumRequired

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

Show allowed values

"minute""hour""day""week""month""quarter""semi_annual""year"

countintegerRequired

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

min: 1 · max: 1000

rolloverobject | nullRequired

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

Show child fields
capobject | nullRequired

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

capPercentagenumber | nullRequired

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

cyclesinteger | nullRequired

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

nextResetAtdate-time | nullRequired

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

startsAtdate-timeRequired

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

expiresAtdate-time | nullRequired

ISO 8601 UTC expiry. Expired sessions and reservations cannot be reused.

revisionintegerRequired

Revision returned by profile reads; updates use it to detect concurrent changes.

min: 0 · max: 9007199254740991

revokedbooleanRequired

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

availablestringRequired

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

pattern: ^(0|[1-9]\d{0,12})(\.\d{1,12})?$

heldstringRequired

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

pattern: ^(0|[1-9]\d{0,12})(\.\d{1,12})?$

spentstringRequired

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

pattern: ^(0|[1-9]\d{0,12})(\.\d{1,12})?$

nextCursoruuid | nullRequired

Next-page cursor; null means end. Pass unchanged and clear when filters change.

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