foliot docs

API reference / Workspaces / Read a workspace's history

Read a workspace's history

GET/workspaces/{workspaceId}/history

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

Who changed whose role, and who removed whom, newest first, limit at a time; nextCursor is present only when older entries remain. Each entry records the actor, the person it was done to, the roles before and after, and the caller’s address; it is written in the same transaction as the change, so a change without its entry cannot exist. Kept permanently. actor and subject are what was recorded and never change; actorName and subjectName are what to show, looked up when the history is read (a person chooses their own name, so it is a label, never an identity). 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. Changes made before this history existed, and an account deleted at Clerk (which removes the person from every workspace they were in), are not in it. An invited address is never in it: an invitation is named by its id.

Path parameters

workspaceId
string (uuid)
REQUIRED

The workspace.

Query parameters

limit
integer (int64)
OPTIONAL

Page size.

min 1 · max 500 · default 100

cursor
string
OPTIONAL

Opaque; the previous page's nextCursor.

pattern ^[0-9]+$

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.