Skip to main content

A2A — Workspaces

The workspaces method namespace provides access to workspace metadata and membership information. Management keys are workspace-scoped, so these methods operate on the workspace that issued the key.

Methods

workspaces.get

Returns the metadata of the workspace associated with the management key.

Params: none

Returns:

{
"id": "ws_abc123",
"name": "Acme Corp",
"slug": "acme",
"plan": "pro",
"created_at": "2024-01-15T10:00:00Z"
}

workspaces.members.list

Returns the list of members in the workspace.

Params: none

Returns: Array of member objects with user_id, email, display_name, role (owner, admin, member), and joined_at.

workspaces.members.invite

Invites a user to the workspace by email. If the user already has a CleverThis account, they are added immediately. If not, an invitation email is sent.

Params:

ParamTypeRequiredDescription
emailstringyesEmail address to invite
rolestringno"member" (default), "admin"

workspaces.members.remove

Removes a member from the workspace.

Params: { "user_id": "usr_abc123" }

Coming soon

workspaces.update (rename, change slug) and workspaces.transfer (change owner) methods are being added.