Skip to main content
18 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_access

Who reaches a project or an area. The owner, everyone granted on it with their level, the workspace-wide row, whether a public link is on, how many tasks it holds, and your own role. Pending invitations are listed to those who may manage it (they carry a link that grants access) and never with their link.

Input

Output

Example

get_task_access

Who can see this task. The owner, everyone it is shared with, and your own role. Pending invitations are included only for the owner: they carry a link that grants access, so they are not something a reader may enumerate.

Input

Output

Example

List your public links. Everything you have published a link to, newest first, with the name of what it points at. The link itself is not here and cannot be: only its hash is stored.

Input

This tool takes no arguments.

Output

Example

list_shared_targets

What is shared with you. Every project or area you reach and do not own: through a grant, or through the workspace-wide row in a workspace you sit in. Each with your level, whose it is, and where it lives: the “Shared with you” section of the sidebar.

Input

This tool takes no arguments.

Output

Example

list_workspace_guests

The guests of a workspace. Everyone from outside the workspace who reaches something in it, with what they reach. Owner and admins only: a guest takes no seat and is not on the members page.

Input

Output

Example

accept_access_invite

Accept an invitation to a project or an area. Accepts a link, but only for the account carrying the address it was sent to; forwarded, it grants nothing. Outside the target’s workspace, the level is Can comment at most.

Input

Output

Example

accept_invite

Accept an invitation. Accepts a link, but only for the account carrying the address it was sent to. An invitation forwarded to someone else grants them nothing.

Input

Output

Example

Publish a public link. Returns the link in url, once. Publishing the same target again returns a fresh link and retires the previous one: a link that has been sent somewhere it should not have been is replaced, not reused.

Input

Output

Example

grant_access

Give someone access, by handle or by email. target is a handle or an email address. A matching account is added at once; an address that matches nobody produces an invitation link to send them. Granting again changes the level. Someone outside the target’s workspace is a guest: the level is capped at Can comment, and clampedToGuest says when it was.

Input

Output

Returns object.

Example

remove_collaborator

Stop sharing with someone. Owner only. Access stops on their next request.

Input

Output

Example

revoke_access

Take someone’s access away. Access stops on their next request.

Input

Output

Example

revoke_access_invite

Cancel a pending invitation. The link stops working immediately.

Input

Output

Example

revoke_invite

Cancel a pending invitation. Owner only. The link stops working immediately.

Input

Output

Example

Take a public link down. The address stops resolving immediately. Anyone holding it sees nothing.

Input

Output

Example

set_access_role

Change someone’s level. A guest stays at Can comment at most. The owner’s level is not a grant.

Input

Output

Example

set_collaborator_role

Change a collaborator’s role. Owner only. The owner’s own role cannot be changed; it is not a membership.

Input

Output

Example

set_workspace_access

Open or close the target to everyone in its workspace. The “Everyone in <workspace>” row: view lets whoever sits in the workspace read it, edit lets them edit, none closes it to all but the people granted. Never reaches anyone outside the workspace.

Input

Output

Example

share_task

Share a task with someone. target is a username or an email address. A matching account is added immediately; an email that matches nobody produces an invitation link to send them. Sharing again with the same person changes their role rather than adding them twice.

Input

Output

Returns object.

Example