Skip to content

List invitations

GET
/api/v1/libraries/{id}/invitations
curl --request GET \
--url http://127.0.0.1:8080/api/v1/libraries/example/invitations \
--header 'Authorization: Bearer <token>'

Metadata and accepted or revoked state, never the secret. Browser session and CSRF protection are required for mutations, except invited local registration. Invitation secrets are returned once and must never be logged.

id
required
string

Completed

Media typeapplication/json
object
invitations
required
Array<object> | null
object
accepted_at
required
integer | null format: int64
created_at
required
integer format: int64
creator
required
string
expires_at
required
integer format: int64
hint
required
string
id
required
string
library_id
required
string
revoked_at
required
integer | null format: int64
role
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
"invitations": [
{
"accepted_at": 1,
"created_at": 1,
"creator": "example",
"expires_at": 1,
"hint": "example",
"id": "example",
"library_id": "example",
"revoked_at": 1,
"role": "example"
}
]
}

No valid session or API token (authentication-required), or the credential sent is invalid (invalid-credentials).

Media typeapplication/problem+json
object
code
required
string
detail
required
string
status
required
integer format: int64
title
required
string
type
required
string
key
additional properties
any
Examplegenerated
{
"code": "example",
"detail": "example",
"status": 1,
"title": "example",
"type": "example"
}