foliot docs

API reference / Platform / List every workspace (platform)

List every workspace (platform)

GET/platform/workspaces

Authenticate with a signed-in Foliot Console session.

Every workspace on the server, with how many members, owners and apps it holds, in id order, limit at a time: the same list GET /workspaces gives the operator token. With needsOwner=true, only the workspaces that need an owner and have none. A signed-in person who holds a platform role (Tin Bee’s staff), read from Foliot’s own table on every request. Everyone else, an operator token and an app key included, is answered 404, the same bytes for all of them. A platform operator or owner. A platform role gives no access to any workspace’s apps, runs or members: this is the summary only.

Query parameters

needsOwner
boolean
OPTIONAL

Only workspaces that need an owner and have none.

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.