How tools work
- You only see the tools you can use. The tool list is filtered by the access you granted and by your role. A member does not see admin-only tools.
- Scopes. Each tool needs one scope, such as
clients:readorclients:write. Write access to an area includes read. See scopes. - Ids. Ids look like
adv_xxx_.... Your AI client should take them from a list or get tool, never guess them. - Paging. List tools return a
next_cursor. Pass it back ascursorfor the next page. - Amounts are whole cents.
- Hints. Each tool tells your AI client whether it only reads, and whether it is destructive. Destructive tools are marked below with “Cannot be undone”.
- Every change is recorded as the person the connection acts as.
tools/list answer is the exact list and argument schema for your connection.
Firm
| Tool | What it does | Scope | Admin only |
|---|---|---|---|
get_organisation | The firm: name, address, brand colour, and the member and role the call acts as. | organisation:read | No |
update_organisation | Changes the firm name, brand colour or logo, and whether Advisor emails clients and shows Secured by Redbark in the portal. | organisation:write | Yes |
Clients
| Tool | What it does | Scope | Admin only |
|---|---|---|---|
list_clients | The firm’s clients, most recent activity first, with status, people and checklist progress. Archived clients are left out. | clients:read | No |
get_client | One client with its people and when each was invited and joined. | clients:read | No |
create_client | Adds a client with one person, an optional second person, an optional checklist template to send and an optional invite. | clients:write | No |
update_client | Renames a client or changes its kind. | clients:write | No |
invite_client | Emails a portal invite to everyone on the client who has an email address and has not joined. | clients:write | No |
resend_client_invite | Sends a reminder of the invite. Earlier invite links stop working. | clients:write | No |
create_client_invite_link | Makes a portal invite link for the firm to send itself. No email is sent. | clients:write | No |
archive_client | Archives a client. Their people can no longer open the portal. Documents and messages are kept. Cannot be undone. | clients:write | No |
Checklist templates
| Tool | What it does | Scope | Admin only |
|---|---|---|---|
list_checklist_templates | The firm’s checklist templates, with how many items each has and how many clients were sent it. | checklists:read | No |
get_checklist_template | One template with its items in order and each item’s questions. | checklists:read | No |
create_checklist_template | Makes a reusable checklist. Each item is a document to upload, a set of questions, or a step to connect banks. | checklists:write | No |
update_checklist_template | Changes a template’s name or description. Clients already sent it keep their copy. | checklists:write | No |
duplicate_checklist_template | Copies a template with the same items. | checklists:write | No |
delete_checklist_template | Removes a template. Clients already sent it keep their checklist. Cannot be undone. | checklists:write | No |
add_checklist_template_item | Adds an item at the end of a template. | checklists:write | No |
update_checklist_template_item | Changes a template item’s title, help, required flag, questions or prefill. | checklists:write | No |
duplicate_checklist_template_item | Copies a template item and puts the copy straight after it. | checklists:write | No |
delete_checklist_template_item | Removes an item from a template. Copies already sent do not change. Cannot be undone. | checklists:write | No |
reorder_checklist_template_items | Puts a template’s items in the order given. | checklists:write | No |
Client checklists
| Tool | What it does | Scope | Admin only |
|---|---|---|---|
list_client_checklists | The checklists sent to a client, with every item’s state, files and answers. | checklists:read | No |
get_checklist | One of a client’s checklists with every item, its files and its answers. | checklists:read | No |
send_checklist | Sends a checklist to a client, from a template or made up on the spot. The client sees it in their portal at once. | checklists:write | No |
rename_checklist | Renames one of a client’s checklists. The template does not change. | checklists:write | No |
remove_checklist | Takes a checklist off a client, with its items and answers. Uploaded documents stay. Cannot be undone. | checklists:write | No |
add_checklist_item | Adds a one-off item to the end of a client’s checklist. | checklists:write | No |
update_checklist_item | Changes an item on a client’s checklist: title, help, required flag, questions or prefill. | checklists:write | No |
delete_checklist_item | Removes an item from a client’s checklist. Uploaded documents stay. Cannot be undone. | checklists:write | No |
reorder_checklist_items | Puts the items of a client’s checklist in the order given. | checklists:write | No |
approve_checklist_item | Approves an item the client submitted. When every required item is done, the checklist is complete. | checklists:write | No |
request_checklist_item_changes | Sends a submitted or done item back to the client with a note on what to change. | checklists:write | No |
Messages
| Tool | What it does | Scope | Admin only |
|---|---|---|---|
list_threads | Every client thread with a message, newest first, with how many messages you have not seen. Can show only unread threads. | messages:read | No |
list_messages | A client’s thread with the firm, newest first, including the lines Advisor posts when the client uploads, submits or connects something. | messages:read | No |
list_document_comments | The comments on one of a client’s documents, with their replies. | messages:read | No |
post_message | Posts a message in a client’s thread as you. Can also comment on a document or reply to a comment. | messages:write | No |
edit_message | Changes the text of your own message, within five minutes of posting it. | messages:write | No |
delete_message | Deletes your own message for the firm and the client. Cannot be undone. | messages:write | No |
mark_thread_read | Marks a client’s thread read up to now, for you. | messages:write | No |
Team
| Tool | What it does | Scope | Admin only |
|---|---|---|---|
list_members | Everyone in the firm, with name, email and role. | members:read | No |
invite_members | Invites up to 10 colleagues by email, each as an admin or a member. | members:write | Yes |
update_member | Makes a member an admin or a member. The last admin cannot be made a member. | members:write | Yes |
remove_member | Removes someone from the firm. Their connected apps and the API keys they made stop working. Their clients stay with the firm. Cannot be undone. | members:write | Yes |
list_member_invitations | Invitations to join the firm that have not been accepted yet. | members:read | No |
revoke_member_invitation | Revokes an open invitation. The link in it stops working. Cannot be undone. | members:write | Yes |
resend_member_invitation | Emails an open invitation again, with the same link. | members:write | Yes |
Reports
| Tool | What it does | Scope | Admin only |
|---|---|---|---|
list_reports | Reports the firm has exported, newest first, optionally for one client. | reports:read | No |
get_report | One report, with a download link that works for 15 minutes. | reports:read | No |
create_report | Exports a balance summary, spending summary or income and expenses report for a client, as a PDF on the firm letterhead or as a CSV. | reports:write | No |
delete_report | Deletes a report and its file. Links already handed out stop working. Cannot be undone. | reports:write | No |
Webhooks
| Tool | What it does | Scope | Admin only |
|---|---|---|---|
list_event_types | The events a webhook endpoint can subscribe to. | webhooks:read | No |
list_webhook_endpoints | The firm’s webhook endpoints, with URL, events, status and the last delivery. | webhooks:read | No |
get_webhook_endpoint | One webhook endpoint. The signing secret shows only as a hint. | webhooks:read | No |
create_webhook_endpoint | Adds an https endpoint for the chosen events and returns its signing secret once. Up to 16 per firm. | webhooks:write | Yes |
update_webhook_endpoint | Changes an endpoint’s URL, events or description, or turns it off or on. | webhooks:write | Yes |
delete_webhook_endpoint | Deletes an endpoint and its delivery history. Cannot be undone. | webhooks:write | Yes |
roll_webhook_secret | Makes a new signing secret. For 24 hours requests are signed with both the new and the old secret. | webhooks:write | Yes |
list_webhook_deliveries | An endpoint’s deliveries from the last 30 days. | webhooks:read | No |
resend_webhook_delivery | Sends a delivery again now. | webhooks:write | Yes |
send_test_webhook | Sends a webhook.test event to one endpoint and returns its answer. | webhooks:write | Yes |
Documents and facts
| Tool | What it does | Scope | Admin only |
|---|---|---|---|
list_documents | A client’s documents, newest first, with status, the kind of document and how many facts it proposed. | documents:read | No |
get_document | One document with what was read from it: facts, proposed balances and the accounts it made or fed. | documents:read | No |
create_document_upload | Returns an address to upload one file to (PDF, JPG, PNG, HEIC, XLSX or CSV, up to 50 MB). | documents:write | No |
get_document_download | Returns an address the original file can be downloaded from for 5 minutes. | documents:read | No |
delete_document | Deletes a document and anything it proposed that was not accepted. Accepted facts and balances are kept. Cannot be undone. | documents:write | No |
list_facts | Facts about a client read from documents, such as an address, with their status. | documents:read | No |
accept_fact | Accepts a fact as read, or with a corrected value. | documents:write | No |
reject_fact | Rejects a fact so it is not used. | documents:write | No |
get_document_type_suggestion | Reads a suggested document type made by suggest_document_type. | documents:read | Yes |
Document review
| Tool | What it does | Scope | Admin only |
|---|---|---|---|
list_document_values | Every field read from a document, with the value kept, the value as read and whether it waits for approval. | documents:read | No |
approve_document_value | Approves one value as read or changed, or adds a value the document did not have. | documents:write | No |
undo_document_value | Puts a value back to how it was read, to review again. | documents:write | No |
approve_document | Approves every value still waiting, then accepts the document’s facts and balance. | documents:write | No |
reopen_document_review | Undoes a document’s approval so its values wait again. | documents:write | No |
read_document_as | Reads a document again as a chosen type. | documents:write | No |
keep_document_as_file | Keeps a document as a file, with nothing read from it. | documents:write | No |
send_back_document | Sends an uploaded file back to the client on its checklist item, with a reason and a note. | documents:write | No |
Document types and client facts
| Tool | What it does | Scope | Admin only |
|---|---|---|---|
list_document_types | Every document type the firm reads, Redbark’s first, then the firm’s own. | document_types:read | No |
get_document_type | One document type with its sections and fields. | document_types:read | No |
create_document_type | Makes a document type of the firm’s own, with its fields. | document_types:write | Yes |
update_document_type | Renames, describes again or regroups one of the firm’s own types. | document_types:write | Yes |
archive_document_type | Stops sorting new files into one of the firm’s own types. | document_types:write | Yes |
restore_document_type | Offers an archived type again. | document_types:write | Yes |
count_unplaced_documents | How many of the firm’s recent documents could not be matched to a type. | document_types:read | No |
suggest_document_type | Suggests a type for a document that could not be matched. Takes about a minute. | document_types:write | Yes |
add_document_type_field | Adds a field of the firm’s own to a document type. | document_types:write | Yes |
update_document_type_field | Changes one of the firm’s own fields. | document_types:write | Yes |
archive_document_type_field | Stops reading one of the firm’s own fields from new documents. | document_types:write | Yes |
restore_document_type_field | Reads an archived field again from new documents. | document_types:write | Yes |
reorder_document_type_fields | Puts the firm’s own fields of a type in the order given. | document_types:write | Yes |
list_fact_definitions | Every client fact the firm keeps, Redbark’s first. | document_types:read | No |
create_fact_definition | Makes a client fact of the firm’s own. | document_types:write | Yes |
update_fact_definition | Renames one of the firm’s own facts. | document_types:write | Yes |
archive_fact_definition | Stops filling one of the firm’s own facts from new documents. | document_types:write | Yes |
restore_fact_definition | Fills an archived fact again from new documents. | document_types:write | Yes |
Money
| Tool | What it does | Scope | Admin only |
|---|---|---|---|
get_money_summary | What a client has and owes from accepted balances: assets, debts and net worth, in total and by institution. | money:read | No |
list_accounts | A client’s open accounts, from connected banks and documents, with the newest balance. | money:read | No |
get_account | One account with its balance history and the documents behind it. | money:read | No |
update_account | Corrects an account made from a document. A connected bank’s accounts cannot be changed. | money:write | No |
accept_balance | Accepts a balance a document proposed, as read or corrected. | money:write | No |
reject_balance | Rejects a balance a document proposed. Cannot be undone. | money:write | No |
list_transactions | Transactions of a client’s connected accounts, newest first, optionally by account and date. Up to 24 months are kept. | money:read | No |
list_connections | A client’s bank connections, including ended ones. | money:read | No |
refresh_connection | Reads balances and recent transactions from the bank now. | money:write | No |
disconnect_connection | Stops sharing a bank and deletes its accounts, balances and transactions. The client must connect again to share it. Cannot be undone. | money:write | No |