Skip to main content
15 tools. Each one is also a REST route and a CLI command, from the same definition: the same input, the same output, the same errors.

get_workspace

One workspace. As you see it: your role, its address, its plan. Not found unless you are in it.

Input

Output

Example

list_workspace_members

Who is in a workspace. The owner, everyone seated, the seats the plan holds, and whether you may invite. Pending invitations are listed to the owner and the admins only (they carry a link that grants a seat) and never with their link.

Input

Output

Example

list_workspaces

The workspaces you are in. Your own personal workspace first (every account has one from signup) then every team you own or sit in, oldest first, each with your role and the plan its owner holds.

Input

This tool takes no arguments.

Output

Example

accept_workspace_invite

Accept an invitation into a workspace. Accepts a link, but only for the account carrying the address it was sent to; forwarded, it grants nothing. Refused when every seat has been taken since it was sent.

Input

Output

Example

create_workspace

Start a team workspace. You become its owner. The address follows the handle rules and must be free among both handles and workspaces. Your personal workspace is not created this way: it exists.

Input

Output

Example

delete_workspace

Delete a team workspace. Owner only. Everything filed in it goes with it. A personal workspace cannot be deleted; deleting the account is what removes it.

Input

Output

Example

invite_workspace_member

Seat someone, by handle or by email. target is a handle or an email address. A matching account sits down at once and takes a seat; an address that matches nobody produces an invitation link to send them. Only while a seat is spare, and only for those the workspace lets invite.

Input

Output

Returns object.

Example

join_workspace

Join a workspace by its link. Sits you down as a member while the link is on and a seat is spare.

Input

Output

Example

leave_workspace

Leave a workspace. Your tasks stay with the team. The owner cannot leave: hand the workspace over first.

Input

Output

Example

remove_workspace_member

Take someone’s seat away. Owner or admin. Their tasks stay in the workspace; their seat is free at once. Not found when they held none.

Input

Output

Example

revoke_workspace_invite

Cancel a pending invitation. Owner or admin. The link stops working immediately.

Input

Output

Example

Switch the join link on or off. Owner or admin. Switching it on mints a fresh link, returned once; switching it off stops the old one at once. Anyone holding the link sits down as a member while a seat is spare.

Input

Output

Example

set_workspace_member_role

Change someone’s role. Owner or admin. The owner has no role to change: handing over is its own operation.

Input

Output

Example

transfer_workspace

Hand a team over. Owner only, to someone already in the workspace, by handle. You stay as an admin. A personal workspace is never handed over.

Input

Output

Example

update_workspace

Rename or re-address a workspace. Renaming is the owner’s; the address, the logo, the time zone and who may invite are an admin’s too. A personal workspace keeps its owner’s handle as its address and cannot be given another.

Input

Output

Example