Skip to content

List Invite links

GET
/api/v1/auth/invites
curl --request GET \
--url https://example.com/api/v1/auth/invites \
--header 'Authorization: Bearer <token>'

Lists the Invite links. It requires a signed-in User with the admin scope and the admin or owner Role. It can return 401 if the session is missing or expired, 403 if access is denied and 429 if the request limit is reached. Route: /api/v1/auth/invites. Inputs: . Safe reads can use bounded retries.

Media typeapplication/json
Array<object>

Admin view of an invite. id is the lowercase hex of the token hash: it names the row for revocation but cannot be redeemed, because only the token itself (shown once at creation) passes consume_invite.

object
consumed_at
integer | null format: int64
consumed_by
string | null format: uuid
created_by
required
string format: uuid
expires_at
required
integer format: int64
id
required
string
quota_override_bytes

None inherits the Instance default; Some(0) means unlimited.

integer | null format: int64
role
required
string
Allowed values: owner admin member guest
Example
[
{
"role": "owner"
}
]

Too many requests

Media typeapplication/json
object
code
required
string
message
required
string
Examplegenerated
{
"code": "example",
"message": "example"
}