Data & Docs ยท CONNECTIONOrganize Brault libraries, folders and files, run boards, comments and pages, and share or transfer files.
Explore 90 workflow actions for Brault, including account permissions and operation limits.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Every id is either added or already on the board.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Appends at the end of the live document, through the collaboration server, so open editors receive it immediately.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Mention a member with the inline token [@ ]; the response lists the mentions that resolved.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Give exactly one of library_id, folder_id, to_root.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a board.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a board property.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a brandspace property.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a folder.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a library.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Give exactly one of library_id, folder_id, to_root.
A repeated request may repeat the external action. Review the previous result before retrying a write.
One call: target, access, password, expiry, anonymous comments and (for a board) the views.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send Brault files and folders as a transfer in one call. Uploading new files into a transfer is not offered.
A repeated request may repeat the external action. Review the previous result before retrying a write.
status and multi_tag properties only.
A repeated request may repeat the external action. Review the previous result before retrying a write.
tag properties only.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Counters for the current windows and the monthly quota of the brandspace.
Permanent: there is no trash for boards.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Its options and every value files hold for it go with it.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Its options and every value files hold for it go with it.
A repeated request may repeat the external action. Review the previous result before retrying a write.
The author, or an owner or admin of the brandspace.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a library.
A repeated request may repeat the external action. Review the previous result before retrying a write.
The author, or an owner or admin of the brandspace.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Permanent. Visitors holding the URL lose access at once.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Irreversible: the version's bytes and every comment attached to it are deleted.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Clears it from every file's value: a status value pointing at it becomes unset, a multi_tag value loses that tag.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete an option.
A repeated request may repeat the external action. Review the previous result before retrying a write.
The author only.
A repeated request may repeat the external action. Review the previous result before retrying a write.
The author only.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Recipients lose access at once.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Every declared upload must be completed first.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Nearest neighbours of this file's embedding.
Downloads a public http(s) URL into the brandspace.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Oldest first.
Oldest first.
Newest first.
User ids only: everyone with an explicit grant plus everyone whose brandspace role carries boards.manage_all.
In position order, each with its options.
Boards of the brandspace the key's creator can see: every board when their role carries boards.manage_all, otherwise only the boards they were granted.
In position order, each with its options.
Files the key's creator can see.
The folder tree the key's creator can see.
Libraries the key's creator can see.
Members of the brandspace with their role.
Pages the key's creator can see, newest first.
List roles.
The brandspace's links, newest first.
Only the boards the key's creator can see.
The brandspace's transfers, newest first, with any open drafts interleaved by creation time.
Make a version the active one.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Give exactly one of library_id, folder_id, to_root.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Give exactly one of library_id, folder_id.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Anyone holding the page's public_url can read it.
A repeated request may repeat the external action. Review the previous result before retrying a write.
A read expressed as POST because its filter is a JSON document.
Removes the membership and this board's values for the file.
A repeated request may repeat the external action. Review the previous result before retrying a write.
A property's type and position are fixed.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Rename or recolor a folder.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Clears resolved_by_id; a reopened comment carries no "reopened at".
A repeated request may repeat the external action. Review the previous result before retrying a write.
Reply to a comment.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Anyone who can view the file.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Restore a trashed file.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Restore a trashed folder.
A repeated request may repeat the external action. Review the previous result before retrying a write.
The board plus its properties and their options.
Retrieve a board property.
Retrieve a brandspace property.
Retrieve a comment.
Full metadata plus renditions signed for 15 minutes.
Retrieve a folder.
Retrieve a library.
Retrieve a member.
The page plus its content.
Retrieve a shared link.
With its files and folders, and a fresh zip URL.
Retrieve an import.
Available to every key, whatever its scopes.
Keyword, semantic and natural-language search over everything the key's creator can see.
Send exactly one field, named after the property's type.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send exactly one field, named after the property's type.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Every event type a webhook endpoint can subscribe to, with its group, a one-line description and the object its payload's data carries.
Moves the file to the trash.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Moves the folder to the trash.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Moves the page to the trash.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Withdraws the public URL.
A repeated request may repeat the external action. Review the previous result before retrying a write.
name, color and emoji are applied first; pinned is applied after them.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a brandspace property.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Rename, replace the tag set, or point a link file at a new URL.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Only name and description are settable.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fields are applied in a fixed order and the first failure stops the sequence - the fields already applied stay applied.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set or clear the password, and/or move the expiry.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update an option.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update an option.
A repeated request may repeat the external action. Review the previous result before retrying a write.
The brandspace, the key's creator, plan and limits behind the API key, and which host serves the brandspace's content.
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
Inspect step outputs and confirm the result in Brault. A saved workflow is not a completed provider action.
