Skip to main content
POST
Preview a library invitation

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.

Path Parameters

invitation_id
string
required

Invitation identifier.

Body

application/json
secret
string<password>
required
write-only

Opaque secret from the invitation URL fragment.

Required string length: 1 - 64

Response

Successful Response

library
LibrarySummary · object
required

Library attribution without content or storage details.

invitation_id
string
required

Previewed invitation identifier.

offered_role
enum<string>
required

Role offered if this account joins.

Available options:
viewer,
collaborator
expires_at
string<date-time>
required

Invitation expiration instant.

eligibility
enum<string>
required

Current eligibility; preview does not reserve a place.

Available options:
joinable,
already_member,
expired,
disabled,
exhausted,
new_invitation_required
current_role
enum<string> | null
required

Existing active role, or null when the account has no current access.

Available options:
owner,
viewer,
collaborator