foliot docs

API reference / Workspaces / List a workspace's members

List a workspace's members

GET/workspaces/{workspaceId}/members

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

The people in the workspace and the role each holds, in userId order, limit at a time; nextCursor is present only when more remain. An owner of the workspace, or an operator token. A member with the operator or viewer role is 403; a workspace the caller is not in answers 404, exactly as one that does not exist. An app key may not. The list is read from Foliot’s own tables on every call: Clerk is where people are invited, and it is never asked who belongs or in which role.

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.