Skip to main content
GET
List stacks in a library

Authorizations

Authorization
string
header
required

Gumnut API key (apikey_...) sent as a Bearer token in the Authorization header. Create and manage keys in the Gumnut app, or with the API key endpoints while signed in to it.

Query Parameters

library_id
string | null

Library to list stacks from. Optional if the user has a single live (non-trashed) library; required when they have multiple.

origin
enum<string> | null

Return only stacks with this provenance. How a stack came to exist.

auto_burst marks a stack the burst detector created from the time + EXIF-camera signal; user marks a stack a user created or edited (manual create, set-cover, add/remove, unstack). The distinction is what keeps re-detection from stomping a user's correction — the detection pass skips user stacks.

Available options:
auto_burst,
user
primary_asset_id
string | null

Return only the stack that pins this asset (with asset_ prefix) as its cover.

ids
string[] | null

Look up specific stacks by ID (max 200; each ID has the asset_stack_ prefix). Accepts multiple ids= query params or a single comma-delimited value (e.g., ids=asset_stack_1,asset_stack_2).

limit
integer
default:20

Maximum number of stacks to return per page (1–200). Defaults to 20.

Required range: 1 <= x <= 200
starting_after_id
string | null

Cursor for pagination. Pass the id of the last stack in the previous response's data to fetch the next page. Omit for the first page.

include
string[] | null

Opt-in expansion fields. Supported values: asset_ids (each stack's live member IDs). Accepts multiple include= query params or a single comma-delimited value. Unknown values return 422.

Response

Successful Response

data
StackResponse · object[]
required

List of stacks

has_more
boolean
required

True if there are more stacks after this page. Pass the last stack's id as starting_after_id to fetch the next page.