foliot docs

API reference / Workspaces / List a workspace's pending invitations

List a workspace's pending invitations

GET/workspaces/{workspaceId}/invitations

Authenticate with an operator token or a signed-in Foliot Console session.

The invitations that have not been accepted, cancelled or expired, in id order, limit at a time; nextCursor is present only when more remain. An owner of the workspace, or an operator token. It carries the invited addresses, so it is not shown to members below owner (403); a workspace the caller is not in answers 404. An app key may not.

Path parameters

workspaceId
string (uuid)
REQUIRED

The workspace.

Query parameters

limit
integer (int64)
OPTIONAL

Page size.

min 1 · max 500 · default 100

cursor
string (uuid)
OPTIONAL

Opaque; the previous page's nextCursor.

Responses

200 object OK
400 Error Invalid request.
401 Error Missing, malformed or unknown bearer token.
403 Error The token is valid but not permitted on this route.
404 Error No such resource.
503 Error A dependency this route needs is unreachable.