Skip to main content
POST
Join a library through an 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

outcome
enum<string>
required

Whether this request admitted the account or returned unchanged access.

Available options:
joined,
already_member
library
LibraryResponse · object
required

Library context with the caller's actual role.

membership
MembershipResponse · object | null
required

Active non-owner membership; null only when the caller owns the library.