Skip to main content
GET
List bodies

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

asset_id
string | null

Return only bodies in this asset.

person_id
string | null

Return only bodies linked to this person.

ids
string[] | null

Look up specific bodies by ID (max 200). IDs use the body_ prefix. Accepts multiple ids= query params or a single comma-delimited value (e.g., ids=body_1,body_2).

limit
integer
default:20

Maximum number of bodies 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 body in the previous response's data to fetch the next page. Omit for the first page.

library_id
string | null

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

Response

Successful Response

data
BodyResponse · object[]
required

List of bodies

has_more
boolean
required

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