Skip to main content
GET
List group lots
Returns individual lots for one LOT mode asset held by a group. The asset_id query parameter is required. For SIMPLE mode assets, use the group balances endpoint. Pass program_id to return only lots whose original economic issuance came from that program. This filter follows the lot’s issuer lineage, including after lot splits or transfers. It does not filter by the program associated with later ledger activity. Each lot includes its original amount, current remaining amount, status, lifecycle timestamps, and reference_id. You can filter by status, expires_before, expires_after, or reference_id. A successful response contains a data array and pagination metadata. Treat a missing or malformed response envelope as an error, not as confirmed empty inventory.
For lot lifecycle and expiration behavior, see the Lots and expiration guide.

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header.

Path Parameters

id
string<uuid>
required

Group ID

Query Parameters

program_id
string<uuid>

Scope lots to original economic issuance by this program

asset_id
string<uuid>
required

Asset ID

status
string

Filter by status: AVAILABLE, HELD, DEFERRED, CONSUMED, EXPIRED

expires_before
string

Filter lots expiring on or before this time (RFC 3339)

expires_after
string

Filter lots expiring on or after this time (RFC 3339)

reference_id
string

Filter lots by reference_id correlation key

limit
integer
default:50

Maximum number of results (default 50, max 200)

Required range: x >= 1
cursor
string

Pagination cursor from previous response

Response

List of group lots

data
object[]

Data contains the list of items

pagination
object

Pagination contains cursor information for fetching more results