Skip to main content
GET
List library invitations

Authorizations

Authorization
string
header
required

First-party Gumnut app session (Clerk session JWT). Only the Gumnut web and mobile apps can obtain one — API keys and OAuth tokens cannot manage credentials or library sharing, so these operations are not callable with the credentials this API otherwise accepts.

Query Parameters

library_id
string | null

Optional owner-library filter; omit to list invitations across all libraries you own.

state
enum<string>
default:all

Return only invitations in this state, or all states.

Available options:
active,
exhausted,
expired,
disabled,
all
limit
integer
default:20

Maximum records per page.

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

Continue after this invitation ID from the previous page.

Response

Successful Response

data
InvitationResponse · object[]
required

Invitation metadata in newest-first order; secrets are omitted.

has_more
boolean
required

Whether another page exists. Pass the last item's ID as starting_after_id and repeat the same library_id and state filters.