Browse the manual
Tool reference
Every agent tool by app, with its HTTP route, grant and the permission the delegated person needs.
On this page
This page lists every tool of the Agent API, grouped by app. The list is made from the installation's own tool registry, so it shows the same tools as GET /api/v1/tools and MCP tools/list for a connection that holds every grant. AI is optional; Pepper needs no AI account.
A connection sees only the tools of the apps that are on and the grants it holds. The delegated person also needs one of the permissions in the Permission column, and record access applies to every call. A connection made inside a customer workspace reaches only the tools with an entry in the Customer workspace column, in that business only, when the person's workspace role and plan allow that ability. See Connect AI in a customer workspace. MCP uses the names in the first column. HTTP uses the route; a write needs an Idempotency-Key header. Each tool's input and output schema comes from GET /api/v1/tools or tools/list.
A tool with the grant …:execute prepares an exact request (its name ends in _prepare) or executes an approved request. Approval comes from the person's decision or a supported rule with limits. See Approve sensitive steps. Steps without a tool are on Steps that stay with people.
Invoices
| Tool | What it does | HTTP | Grant | Permission | Customer workspace |
|---|---|---|---|---|---|
invoices_receivables |
Explain overdue balances | GET /api/v1/invoices/receivables |
invoices:finance-summary |
financial_summary.view |
— |
tax_rates_list |
List tax rates | GET /api/v1/tax-rates |
invoices:read |
invoices.view or invoices.view_own or invoices.manage |
— |
online-payments_get |
Read online payments | GET /api/v1/documents/{id}/online-payments |
invoices:read |
invoices.view or invoices.view_own |
— |
online-payments_prepare |
Prepare an online payment | POST /api/v1/online-payments/prepare |
invoices:prepare |
invoices.manage |
— |
documents_list |
List documents | GET /api/v1/documents |
invoices:read |
invoices.view or invoices.view_own |
— |
documents_get |
Read a document | GET /api/v1/documents/{id} |
invoices:read |
invoices.view or invoices.view_own |
— |
documents_preview |
Preview exact totals | POST /api/v1/documents/preview |
invoices:read |
invoices.manage |
— |
drafts_create |
Prepare a document draft | POST /api/v1/drafts |
invoices:prepare |
invoices.manage |
— |
drafts_update |
Change a document draft | PUT /api/v1/drafts/{id} |
invoices:prepare |
invoices.manage |
— |
documents_issue_prepare |
Ask to issue an invoice | POST /api/v1/documents/{id}/issue-approvals |
invoices:execute |
invoices.finalize |
— |
approvals_get |
Read an approval | GET /api/v1/approvals/{id} |
invoices:read |
Any connection | — |
approvals_cancel |
Cancel an approval request | POST /api/v1/approvals/{id}/cancel |
invoices:prepare |
Any connection | — |
documents_issue |
Issue an approved invoice | POST /api/v1/approvals/{id}/execute |
invoices:execute |
invoices.finalize |
— |
views_document |
View documents | GET /api/v1/views/document |
invoices:read |
invoices.view or invoices.view_own |
— |
tax_policies_financial_options |
Read financial tax choices | GET /api/v1/tax-policies/financial/options |
invoices:read |
invoices.manage |
— |
tax_policies_financial_prepare |
Review tax selection | POST /api/v1/tax-policies/financial/prepare |
invoices:read |
invoices.manage |
— |
drafts_credit_note |
Start a credit-note draft | POST /api/v1/documents/{id}/credit-notes |
invoices:prepare |
invoices.manage |
— |
documents_duplicate |
Duplicate a document | POST /api/v1/documents/{id}/duplicate |
invoices:prepare |
invoices.manage |
— |
documents_pdf |
Download a document PDF | GET /api/v1/documents/{id}/pdf |
invoices:read |
invoices.view or invoices.view_own |
— |
documents_pdf_copy |
Download a document copy | GET /api/v1/documents/{id}/pdf-copy |
invoices:read |
invoices.view or invoices.view_own |
— |
documents_xml |
Download the e-invoice XML | GET /api/v1/documents/{id}/xml |
invoices:read |
invoices.view or invoices.view_own |
— |
documents_messages |
Read a document’s messages | GET /api/v1/documents/{id}/messages |
invoices:read |
invoices.view or invoices.view_own |
— |
documents_email_draft |
Read the email options | GET /api/v1/documents/{id}/email |
invoices:read |
invoices.manage |
— |
documents_email_preview |
Preview an email | POST /api/v1/documents/{id}/email/preview |
invoices:read |
invoices.manage |
— |
documents_note |
Add an internal note | POST /api/v1/documents/{id}/notes |
invoices:prepare |
invoices.manage |
— |
recurring_list |
List recurring schedules | GET /api/v1/recurring |
invoices:read |
invoices.manage |
— |
recurring_get |
Read a recurring schedule | GET /api/v1/recurring/{id} |
invoices:read |
invoices.manage |
— |
payments_settings |
Read online payment settings | GET /api/v1/payments/settings |
invoices:read |
invoices.manage |
— |
documents_review_preview |
Preview an AI invoice review | POST /api/v1/documents/{id}/review/preview |
invoices:read |
invoices.view or invoices.view_own |
— |
documents_review |
Run an AI invoice review | POST /api/v1/documents/{id}/review |
invoices:prepare |
invoices.view or invoices.view_own |
— |
documents_review_feedback |
Mark an AI review answer | POST /api/v1/review-decisions/{id}/feedback |
invoices:prepare |
invoices.view or invoices.view_own |
— |
documents_delete_draft_prepare |
Request approval: Delete a draft | POST /api/v1/approvals/documents-delete-draft/{id} |
invoices:execute |
invoices.manage |
— |
documents_delete_draft |
Delete a draft | POST /api/v1/approvals/{id}/documents-delete-draft |
invoices:execute |
invoices.manage |
— |
documents_cancel_prepare |
Request approval: Cancel an issued document | POST /api/v1/approvals/documents-cancel/{id} |
invoices:execute |
invoices.manage |
— |
documents_cancel |
Cancel an issued document | POST /api/v1/approvals/{id}/documents-cancel |
invoices:execute |
invoices.manage |
— |
payments_record_prepare |
Request approval: Record a payment | POST /api/v1/approvals/payments-record/{id} |
invoices:execute |
invoices.manage |
— |
payments_record |
Record a payment | POST /api/v1/approvals/{id}/payments-record |
invoices:execute |
invoices.manage |
— |
payments_reverse_prepare |
Request approval: Reverse a payment | POST /api/v1/approvals/payments-reverse/{id} |
invoices:execute |
invoices.manage |
— |
payments_reverse |
Reverse a payment | POST /api/v1/approvals/{id}/payments-reverse |
invoices:execute |
invoices.manage |
— |
refunds_record_prepare |
Request approval: Record a refund | POST /api/v1/approvals/refunds-record/{id} |
invoices:execute |
invoices.manage |
— |
refunds_record |
Record a refund | POST /api/v1/approvals/{id}/refunds-record |
invoices:execute |
invoices.manage |
— |
refunds_reverse_prepare |
Request approval: Reverse a refund | POST /api/v1/approvals/refunds-reverse/{id} |
invoices:execute |
invoices.manage |
— |
refunds_reverse |
Reverse a refund | POST /api/v1/approvals/{id}/refunds-reverse |
invoices:execute |
invoices.manage |
— |
quotes_accept_prepare |
Request approval: Record that a quote was accepted | POST /api/v1/approvals/quotes-accept/{id} |
invoices:execute |
invoices.manage |
— |
quotes_accept |
Record that a quote was accepted | POST /api/v1/approvals/{id}/quotes-accept |
invoices:execute |
invoices.manage |
— |
quotes_decline_prepare |
Request approval: Record that a quote was declined | POST /api/v1/approvals/quotes-decline/{id} |
invoices:execute |
invoices.manage |
— |
quotes_decline |
Record that a quote was declined | POST /api/v1/approvals/{id}/quotes-decline |
invoices:execute |
invoices.manage |
— |
quotes_convert_prepare |
Request approval: Turn a quote into an invoice draft | POST /api/v1/approvals/quotes-convert/{id} |
invoices:execute |
invoices.manage |
— |
quotes_convert |
Turn a quote into an invoice draft | POST /api/v1/approvals/{id}/quotes-convert |
invoices:execute |
invoices.manage |
— |
proformas_convert_prepare |
Request approval: Turn a pro forma into an invoice draft | POST /api/v1/approvals/proformas-convert/{id} |
invoices:execute |
invoices.manage |
— |
proformas_convert |
Turn a pro forma into an invoice draft | POST /api/v1/approvals/{id}/proformas-convert |
invoices:execute |
invoices.manage |
— |
documents_send_prepare |
Request approval: Send a document by email | POST /api/v1/approvals/documents-send/{id} |
invoices:execute |
invoices.manage |
— |
documents_send |
Send a document by email | POST /api/v1/approvals/{id}/documents-send |
invoices:execute |
invoices.manage |
— |
documents_remind_prepare |
Request approval: Send a payment reminder | POST /api/v1/approvals/documents-remind/{id} |
invoices:execute |
invoices.manage |
— |
documents_remind |
Send a payment reminder | POST /api/v1/approvals/{id}/documents-remind |
invoices:execute |
invoices.manage |
— |
documents_reminders_pause_prepare |
Request approval: Pause or resume reminders | POST /api/v1/approvals/documents-reminders-pause/{id} |
invoices:execute |
invoices.manage |
— |
documents_reminders_pause |
Pause or resume reminders | POST /api/v1/approvals/{id}/documents-reminders-pause |
invoices:execute |
invoices.manage |
— |
documents_record_delivery_prepare |
Request approval: Record a delivery outside Pepper | POST /api/v1/approvals/documents-record-delivery/{id} |
invoices:execute |
invoices.manage |
— |
documents_record_delivery |
Record a delivery outside Pepper | POST /api/v1/approvals/{id}/documents-record-delivery |
invoices:execute |
invoices.manage |
— |
recurring_save_prepare |
Request approval: Save a recurring schedule | POST /api/v1/approvals/recurring-save |
invoices:execute |
invoices.manage |
— |
recurring_save |
Save a recurring schedule | POST /api/v1/approvals/{id}/recurring-save |
invoices:execute |
invoices.manage |
— |
recurring_run_prepare |
Request approval: Create the next recurring invoice | POST /api/v1/approvals/recurring-run/{id} |
invoices:execute |
invoices.manage |
— |
recurring_run |
Create the next recurring invoice | POST /api/v1/approvals/{id}/recurring-run |
invoices:execute |
invoices.manage |
— |
recurring_change_prepare |
Request approval: Pause, resume or delete a schedule | POST /api/v1/approvals/recurring-change/{id} |
invoices:execute |
invoices.manage |
— |
recurring_change |
Pause, resume or delete a schedule | POST /api/v1/approvals/{id}/recurring-change |
invoices:execute |
invoices.manage |
— |
payments_online_enable_prepare |
Request approval: Switch online payments on or off | POST /api/v1/approvals/payments-online-enable |
invoices:execute |
invoices.manage |
shop.money |
payments_online_enable |
Switch online payments on or off | POST /api/v1/approvals/{id}/payments-online-enable |
invoices:execute |
invoices.manage |
shop.money |
payments_online_refund_prepare |
Request approval: Send an online refund | POST /api/v1/approvals/payments-online-refund/{id} |
invoices:execute |
invoices.manage |
shop.money |
payments_online_refund |
Send an online refund | POST /api/v1/approvals/{id}/payments-online-refund |
invoices:execute |
invoices.manage |
shop.money |
payments_online_check_prepare |
Request approval: Check an online payment with Stripe | POST /api/v1/approvals/payments-online-check/{id} |
invoices:execute |
invoices.manage |
— |
payments_online_check |
Check an online payment with Stripe | POST /api/v1/approvals/{id}/payments-online-check |
invoices:execute |
invoices.manage |
— |
payments_online_recover_prepare |
Request approval: Link an online payment to its Stripe record | POST /api/v1/approvals/payments-online-recover/{id} |
invoices:execute |
invoices.manage |
— |
payments_online_recover |
Link an online payment to its Stripe record | POST /api/v1/approvals/{id}/payments-online-recover |
invoices:execute |
invoices.manage |
— |
Customers
| Tool | What it does | HTTP | Grant | Permission | Customer workspace |
|---|---|---|---|---|---|
customers_context |
Show customer context | GET /api/v1/customers/{id}/context |
customers:read |
customers.view |
— |
customers_workspace |
Read a customer workspace | GET /api/v1/customers/{id}/workspace |
customers:read |
customers.view |
— |
customer_accounts_list |
Accounts | GET /api/v1/customer-accounts |
customers:read |
customers.view |
— |
customer_accounts_get |
Open account | GET /api/v1/customer-accounts/{id} |
customers:read |
customers.view |
— |
customer_accounts_duplicates |
Possible duplicates | GET /api/v1/customer-accounts/{id}/duplicates |
customers:read |
customers.view |
— |
customer_accounts_privacy |
Privacy | GET /api/v1/customer-accounts/{id}/privacy |
customers:read |
customers.accounts.manage |
— |
account_get |
Read your account | GET /api/v1/account |
customers:read |
Workspace only | access.read |
account_update |
Change your account details | PUT /api/v1/account |
customers:prepare |
Workspace only | account.manage |
account_team |
Read your account team | GET /api/v1/account/team |
customers:read |
Workspace only | team.manage |
account_team_widgets |
Read the widgets you can share with staff | GET /api/v1/account/team/widgets |
customers:read |
Workspace only | team.manage |
account_people |
Read your collected people | GET /api/v1/account/people |
customers:read |
Workspace only | contacts.read |
account_person |
Read one collected person | GET /api/v1/account/people/{id} |
customers:read |
Workspace only | contacts.read |
account_billing |
Read your invoices from your provider | GET /api/v1/account/billing |
customers:read |
Workspace only | billing.read |
account_record |
Read one collected record | GET /api/v1/account/records/{id} |
customers:read |
Workspace only | contacts.read |
account_items |
Read your catalogue | GET /api/v1/account/items |
customers:read |
Workspace only | widget.price_list or widget.menu or widget.estimator |
account_item |
Read one catalogue item | GET /api/v1/account/items/{id} |
customers:read |
Workspace only | widget.price_list or widget.menu or widget.estimator |
account_item_save |
Save a catalogue item | POST /api/v1/account/items |
customers:prepare |
Workspace only | widget.price_list or widget.menu or widget.estimator |
account_shop |
Read your shop overview | GET /api/v1/account/shop |
customers:read |
Workspace only | shop.read |
account_shop_orders |
Read your shop's orders | GET /api/v1/account/shop/orders |
customers:read |
Workspace only | shop.orders |
account_shop_products |
Read your shop's products | GET /api/v1/account/shop/products |
customers:read |
Workspace only | shop.stock |
account_shop_product_save |
Save a shop product | POST /api/v1/account/shop/products |
customers:prepare |
Workspace only | shop.manage |
account_shop_documents |
Read your shop's invoices | GET /api/v1/account/shop/documents |
customers:read |
Workspace only | shop.money |
account_shop_setup |
Read your shop setup | GET /api/v1/account/shop/setup |
customers:read |
Workspace only | shop.money |
customers_search |
Search customers | GET /api/v1/customers |
customers:read |
customers.view |
— |
views_customer |
View customers | GET /api/v1/views/customer |
customers:read |
customers.view |
— |
customers_create_prepare |
Request approval: Add a customer | POST /api/v1/approvals/customers-create |
customers:execute |
customers.manage |
— |
customers_create |
Add a customer | POST /api/v1/approvals/{id}/customers-create |
customers:execute |
customers.manage |
— |
customers_update_prepare |
Request approval: Change a customer | POST /api/v1/approvals/customers-update/{id} |
customers:execute |
customers.manage |
— |
customers_update |
Change a customer | POST /api/v1/approvals/{id}/customers-update |
customers:execute |
customers.manage |
— |
customers_delete_prepare |
Request approval: Delete a customer | POST /api/v1/approvals/customers-delete/{id} |
customers:execute |
customers.manage |
— |
customers_delete |
Delete a customer | POST /api/v1/approvals/{id}/customers-delete |
customers:execute |
customers.manage |
— |
customers_contact_save_prepare |
Request approval: Save a customer contact | POST /api/v1/approvals/customers-contact-save/{id} |
customers:execute |
customers.manage |
— |
customers_contact_save |
Save a customer contact | POST /api/v1/approvals/{id}/customers-contact-save |
customers:execute |
customers.manage |
— |
customers_contact_delete_prepare |
Request approval: Delete a customer contact | POST /api/v1/approvals/customers-contact-delete/{id} |
customers:execute |
customers.manage |
— |
customers_contact_delete |
Delete a customer contact | POST /api/v1/approvals/{id}/customers-contact-delete |
customers:execute |
customers.manage |
— |
customers_suppression_add_prepare |
Request approval: Stop automatic messages to an address | POST /api/v1/approvals/customers-suppression-add/{id} |
customers:execute |
customers.manage |
— |
customers_suppression_add |
Stop automatic messages to an address | POST /api/v1/approvals/{id}/customers-suppression-add |
customers:execute |
customers.manage |
— |
customers_contact_reorder_prepare |
Request approval: Reorder customer contacts | POST /api/v1/approvals/customers-contact-reorder/{id} |
customers:execute |
customers.manage |
— |
customers_contact_reorder |
Reorder customer contacts | POST /api/v1/approvals/{id}/customers-contact-reorder |
customers:execute |
customers.manage |
— |
customers_import_prepare |
Request approval: Import customers | POST /api/v1/approvals/customers-import |
customers:execute |
customers.manage |
— |
customers_import |
Import customers | POST /api/v1/approvals/{id}/customers-import |
customers:execute |
customers.manage |
— |
customers_export_prepare |
Request approval: Export customers | POST /api/v1/approvals/customers-export |
customers:execute |
customers.view |
— |
customers_export |
Export customers | POST /api/v1/approvals/{id}/customers-export |
customers:execute |
customers.view |
— |
customers_workspace_provision_prepare |
Request approval: Open a hosted workspace | POST /api/v1/approvals/customers-workspace-provision/{id} |
customers:execute |
customers.manage |
— |
customers_workspace_provision |
Open a hosted workspace | POST /api/v1/approvals/{id}/customers-workspace-provision |
customers:execute |
customers.manage |
— |
customers_workspace_plan_prepare |
Request approval: Put a workspace on a plan | POST /api/v1/approvals/customers-workspace-plan/{id} |
customers:execute |
customers.manage |
— |
customers_workspace_plan |
Put a workspace on a plan | POST /api/v1/approvals/{id}/customers-workspace-plan |
customers:execute |
customers.manage |
— |
customers_workspace_state_prepare |
Request approval: Change a workspace state | POST /api/v1/approvals/customers-workspace-state/{id} |
customers:execute |
customers.manage |
— |
customers_workspace_state |
Change a workspace state | POST /api/v1/approvals/{id}/customers-workspace-state |
customers:execute |
customers.manage |
— |
customers_workspace_resend_prepare |
Request approval: Resend a workspace invitation | POST /api/v1/approvals/customers-workspace-resend/{id} |
customers:execute |
customers.manage |
— |
customers_workspace_resend |
Resend a workspace invitation | POST /api/v1/approvals/{id}/customers-workspace-resend |
customers:execute |
customers.manage |
— |
customer_accounts_disable_prepare |
Request approval: Disable access | POST /api/v1/approvals/customer-accounts-disable/{id} |
customers:execute |
customers.accounts.manage |
— |
customer_accounts_disable |
Disable access | POST /api/v1/approvals/{id}/customer-accounts-disable |
customers:execute |
customers.accounts.manage |
— |
customer_accounts_enable_prepare |
Request approval: Enable access | POST /api/v1/approvals/customer-accounts-enable/{id} |
customers:execute |
customers.accounts.manage |
— |
customer_accounts_enable |
Enable access | POST /api/v1/approvals/{id}/customer-accounts-enable |
customers:execute |
customers.accounts.manage |
— |
customer_accounts_revoke_sessions_prepare |
Request approval: Sign out everywhere | POST /api/v1/approvals/customer-accounts-revoke-sessions/{id} |
customers:execute |
customers.accounts.manage |
— |
customer_accounts_revoke_sessions |
Sign out everywhere | POST /api/v1/approvals/{id}/customer-accounts-revoke-sessions |
customers:execute |
customers.accounts.manage |
— |
customer_accounts_relink_prepare |
Request approval: Change linked Customer | POST /api/v1/approvals/customer-accounts-relink/{id} |
customers:execute |
customers.accounts.manage |
— |
customer_accounts_relink |
Change linked Customer | POST /api/v1/approvals/{id}/customer-accounts-relink |
customers:execute |
customers.accounts.manage |
— |
customer_accounts_reverse_relink_prepare |
Request approval: Restore previous link | POST /api/v1/approvals/customer-accounts-reverse-relink/{id} |
customers:execute |
customers.accounts.manage |
— |
customer_accounts_reverse_relink |
Restore previous link | POST /api/v1/approvals/{id}/customer-accounts-reverse-relink |
customers:execute |
customers.accounts.manage |
— |
customer_accounts_resolve_deletion_prepare |
Request approval: Record decision | POST /api/v1/approvals/customer-accounts-resolve-deletion/{id} |
customers:execute |
customers.accounts.manage |
— |
customer_accounts_resolve_deletion |
Record decision | POST /api/v1/approvals/{id}/customer-accounts-resolve-deletion |
customers:execute |
customers.accounts.manage |
— |
customer_accounts_export_prepare |
Request approval: Export account data | POST /api/v1/approvals/customer-accounts-export/{id} |
customers:execute |
customers.accounts.manage |
— |
customer_accounts_export |
Export account data | POST /api/v1/approvals/{id}/customer-accounts-export |
customers:execute |
customers.accounts.manage |
— |
customers_message_send_prepare |
Request approval: Send a follow-up message | POST /api/v1/approvals/customers-message-send |
customers:execute |
customers.manage |
— |
customers_message_send |
Send a follow-up message | POST /api/v1/approvals/{id}/customers-message-send |
customers:execute |
customers.manage |
— |
account_team_invite_prepare |
Request approval to invite a staff member to your account | POST /api/v1/approvals/account-team-invite |
customers:execute |
Workspace only | team.manage |
account_team_invite |
Invite a staff member to your account | POST /api/v1/approvals/{id}/account-team-invite |
customers:execute |
Workspace only | team.manage |
account_team_resend_prepare |
Request approval to send an account invitation again | POST /api/v1/approvals/account-team-resend/{id} |
customers:execute |
Workspace only | team.manage |
account_team_resend |
Send an account invitation again | POST /api/v1/approvals/{id}/account-team-resend |
customers:execute |
Workspace only | team.manage |
account_team_cancel_prepare |
Request approval to cancel an account invitation | POST /api/v1/approvals/account-team-cancel/{id} |
customers:execute |
Workspace only | team.manage |
account_team_cancel |
Cancel an account invitation | POST /api/v1/approvals/{id}/account-team-cancel |
customers:execute |
Workspace only | team.manage |
account_team_revoke_prepare |
Request approval to remove a staff member from your account | POST /api/v1/approvals/account-team-revoke/{id} |
customers:execute |
Workspace only | team.revoke |
account_team_revoke |
Remove a staff member from your account | POST /api/v1/approvals/{id}/account-team-revoke |
customers:execute |
Workspace only | team.revoke |
account_people_export_prepare |
Request approval to export your account's collected people | POST /api/v1/approvals/account-people-export |
customers:execute |
Workspace only | exports.read |
account_people_export |
Export your account's collected people | POST /api/v1/approvals/{id}/account-people-export |
customers:execute |
Workspace only | exports.read |
account_privacy_lookup_prepare |
Request approval to find a person for a data request | POST /api/v1/approvals/account-privacy-lookup |
customers:execute |
Workspace only | privacy.manage |
account_privacy_lookup |
Find a person for a data request | POST /api/v1/approvals/{id}/account-privacy-lookup |
customers:execute |
Workspace only | privacy.manage |
account_privacy_report_prepare |
Request approval to make a collected person's personal-data report | POST /api/v1/approvals/account-privacy-report |
customers:execute |
Workspace only | privacy.manage |
account_privacy_report |
Make a collected person's personal-data report | POST /api/v1/approvals/{id}/account-privacy-report |
customers:execute |
Workspace only | privacy.manage |
account_privacy_erase_prepare |
Request approval to erase a collected person's personal data | POST /api/v1/approvals/account-privacy-erase |
customers:execute |
Workspace only | privacy.manage |
account_privacy_erase |
Erase a collected person's personal data | POST /api/v1/approvals/{id}/account-privacy-erase |
customers:execute |
Workspace only | privacy.manage |
account_privacy_hold_prepare |
Request approval to set a retention hold on a collected person | POST /api/v1/approvals/account-privacy-hold |
customers:execute |
Workspace only | privacy.manage |
account_privacy_hold |
Set a retention hold on a collected person | POST /api/v1/approvals/{id}/account-privacy-hold |
customers:execute |
Workspace only | privacy.manage |
account_privacy_file_prepare |
Request approval to download a collected person's file | POST /api/v1/approvals/account-privacy-file |
customers:execute |
Workspace only | privacy.manage |
account_privacy_file |
Download a collected person's file | POST /api/v1/approvals/{id}/account-privacy-file |
customers:execute |
Workspace only | privacy.manage |
account_billing_pdf_prepare |
Request approval to download an invoice from your provider | POST /api/v1/approvals/account-billing-pdf |
customers:execute |
Workspace only | billing.read |
account_billing_pdf |
Download an invoice from your provider | POST /api/v1/approvals/{id}/account-billing-pdf |
customers:execute |
Workspace only | billing.read |
account_record_file_prepare |
Request approval to download a form submission file | POST /api/v1/approvals/account-record-file |
customers:execute |
Workspace only | contacts.read |
account_record_file |
Download a form submission file | POST /api/v1/approvals/{id}/account-record-file |
customers:execute |
Workspace only | contacts.read |
account_shop_seller_save_prepare |
Request approval to save your shop's business details | POST /api/v1/approvals/account-shop-seller-save |
customers:execute |
Workspace only | shop.money |
account_shop_seller_save |
Save your shop's business details | POST /api/v1/approvals/{id}/account-shop-seller-save |
customers:execute |
Workspace only | shop.money |
account_shop_tax_rate_save_prepare |
Request approval to save a shop tax rate | POST /api/v1/approvals/account-shop-tax-rate-save |
customers:execute |
Workspace only | shop.money |
account_shop_tax_rate_save |
Save a shop tax rate | POST /api/v1/approvals/{id}/account-shop-tax-rate-save |
customers:execute |
Workspace only | shop.money |
account_shop_document_pdf_prepare |
Request approval to download an invoice of your shop | POST /api/v1/approvals/account-shop-document-pdf |
customers:execute |
Workspace only | shop.money |
account_shop_document_pdf |
Download an invoice of your shop | POST /api/v1/approvals/{id}/account-shop-document-pdf |
customers:execute |
Workspace only | shop.money |
account_shop_export_prepare |
Request approval to download your shop's invoices for a period | POST /api/v1/approvals/account-shop-export |
customers:execute |
Workspace only | shop.money |
account_shop_export |
Download your shop's invoices for a period | POST /api/v1/approvals/{id}/account-shop-export |
customers:execute |
Workspace only | shop.money |
account_team_shop_prepare |
Request approval to change a staff member's shop access | POST /api/v1/approvals/account-team-shop/{id} |
customers:execute |
Workspace only | shop.money |
account_team_shop |
Change a staff member's shop access | POST /api/v1/approvals/{id}/account-team-shop |
customers:execute |
Workspace only | shop.money |
Sales
| Tool | What it does | HTTP | Grant | Permission | Customer workspace |
|---|---|---|---|---|---|
leads_list |
List leads | GET /api/v1/leads |
crm:read |
crm.use or crm.manage |
— |
leads_get |
Read a lead | GET /api/v1/leads/{id} |
crm:read |
crm.use or crm.manage |
— |
leads_create |
Add a lead | POST /api/v1/leads |
crm:prepare |
crm.use or crm.manage |
— |
leads_qualify |
Qualify a lead into a customer and a deal | POST /api/v1/leads/{id}/qualify |
crm:prepare |
crm.use or crm.manage |
— |
deals_list |
List deals | GET /api/v1/deals |
crm:read |
crm.use or crm.manage |
— |
deals_get |
Read a deal | GET /api/v1/deals/{id} |
crm:read |
crm.use or crm.manage |
— |
deals_create |
Add a deal | POST /api/v1/deals |
crm:prepare |
crm.use or crm.manage |
— |
deals_move |
Move a deal to a stage | POST /api/v1/deals/{id}/move |
crm:prepare |
crm.use or crm.manage |
— |
deals_outcome |
Record a deal as won or lost | POST /api/v1/deals/{id}/outcome |
crm:prepare |
crm.use or crm.manage |
— |
deals_prepare_quote |
Prepare a quote draft for a deal | POST /api/v1/deals/{id}/quote |
crm:prepare |
invoices.manage |
— |
sales_overview |
Read the sales overview | GET /api/v1/sales/overview |
crm:read |
crm.use or crm.manage |
— |
sales_stages |
List the pipeline stages | GET /api/v1/sales/stages |
crm:read |
crm.use or crm.manage |
— |
leads_matches |
Find matches for a lead | GET /api/v1/leads/{id}/matches |
crm:read |
crm.use or crm.manage |
— |
deals_timeline |
Read a deal’s history | GET /api/v1/deals/{id}/timeline |
crm:read |
crm.use or crm.manage |
— |
leads_update |
Change a lead | PUT /api/v1/leads/{id} |
crm:prepare |
crm.use or crm.manage |
— |
leads_next_step |
Set a lead’s next step | POST /api/v1/leads/{id}/next-step |
crm:prepare |
crm.use or crm.manage |
— |
leads_assign |
Assign a lead | POST /api/v1/leads/{id}/assignee |
crm:prepare |
crm.use or crm.manage |
— |
leads_contacted |
Mark a lead as contacted | POST /api/v1/leads/{id}/contacted |
crm:prepare |
crm.use or crm.manage |
— |
leads_unqualify |
Close a lead as unqualified | POST /api/v1/leads/{id}/unqualify |
crm:prepare |
crm.use or crm.manage |
— |
leads_reopen |
Reopen a lead | POST /api/v1/leads/{id}/reopen |
crm:prepare |
crm.use or crm.manage |
— |
leads_archive |
Archive or restore a lead | POST /api/v1/leads/{id}/archive |
crm:prepare |
crm.use or crm.manage |
— |
leads_tag |
Tag a lead | POST /api/v1/leads/{id}/tags |
crm:prepare |
crm.use or crm.manage |
— |
deals_update |
Change a deal | PUT /api/v1/deals/{id} |
crm:prepare |
crm.use or crm.manage |
— |
deals_next_step |
Set a deal’s next step | POST /api/v1/deals/{id}/next-step |
crm:prepare |
crm.use or crm.manage |
— |
deals_assign |
Assign a deal | POST /api/v1/deals/{id}/assignee |
crm:prepare |
crm.use or crm.manage |
— |
deals_reopen |
Reopen a deal | POST /api/v1/deals/{id}/reopen |
crm:prepare |
crm.use or crm.manage |
— |
deals_archive |
Archive or restore a deal | POST /api/v1/deals/{id}/archive |
crm:prepare |
crm.use or crm.manage |
— |
deals_tag |
Tag a deal | POST /api/v1/deals/{id}/tags |
crm:prepare |
crm.use or crm.manage |
— |
deals_open_project |
Open the project of a won deal | POST /api/v1/deals/{id}/project |
crm:prepare |
crm.use or crm.manage |
— |
sales_next_step_task |
Turn a next step into a task | POST /api/v1/sales/{id}/task |
crm:prepare |
crm.use or crm.manage |
— |
views_lead |
View leads | GET /api/v1/views/lead |
crm:read |
crm.use or crm.manage |
— |
views_deal |
View deals | GET /api/v1/views/deal |
crm:read |
crm.use or crm.manage |
— |
views_lead_bulk |
Change many leads | POST /api/v1/views/lead/bulk |
crm:prepare |
crm.use or crm.manage |
— |
views_deal_bulk |
Change many deals | POST /api/v1/views/deal/bulk |
crm:prepare |
crm.use or crm.manage |
— |
views_deal_move |
Move a deal on the board | POST /api/v1/views/deal/move/{id} |
crm:prepare |
crm.use or crm.manage |
— |
pipeline_stage_create_prepare |
Request approval: Add a pipeline stage | POST /api/v1/approvals/pipeline-stage-create |
crm:execute |
crm.manage |
— |
pipeline_stage_create |
Add a pipeline stage | POST /api/v1/approvals/{id}/pipeline-stage-create |
crm:execute |
crm.manage |
— |
pipeline_stage_update_prepare |
Request approval: Change a pipeline stage | POST /api/v1/approvals/pipeline-stage-update/{id} |
crm:execute |
crm.manage |
— |
pipeline_stage_update |
Change a pipeline stage | POST /api/v1/approvals/{id}/pipeline-stage-update |
crm:execute |
crm.manage |
— |
pipeline_stage_reorder_prepare |
Request approval: Reorder pipeline stages | POST /api/v1/approvals/pipeline-stage-reorder |
crm:execute |
crm.manage |
— |
pipeline_stage_reorder |
Reorder pipeline stages | POST /api/v1/approvals/{id}/pipeline-stage-reorder |
crm:execute |
crm.manage |
— |
pipeline_stage_archive_prepare |
Request approval: Archive a pipeline stage | POST /api/v1/approvals/pipeline-stage-archive/{id} |
crm:execute |
crm.manage |
— |
pipeline_stage_archive |
Archive a pipeline stage | POST /api/v1/approvals/{id}/pipeline-stage-archive |
crm:execute |
crm.manage |
— |
pipeline_reason_create_prepare |
Request approval: Add a lost reason | POST /api/v1/approvals/pipeline-reason-create |
crm:execute |
crm.manage |
— |
pipeline_reason_create |
Add a lost reason | POST /api/v1/approvals/{id}/pipeline-reason-create |
crm:execute |
crm.manage |
— |
pipeline_reason_update_prepare |
Request approval: Rename a lost reason | POST /api/v1/approvals/pipeline-reason-update/{id} |
crm:execute |
crm.manage |
— |
pipeline_reason_update |
Rename a lost reason | POST /api/v1/approvals/{id}/pipeline-reason-update |
crm:execute |
crm.manage |
— |
pipeline_reason_archive_prepare |
Request approval: Archive a lost reason | POST /api/v1/approvals/pipeline-reason-archive/{id} |
crm:execute |
crm.manage |
— |
pipeline_reason_archive |
Archive a lost reason | POST /api/v1/approvals/{id}/pipeline-reason-archive |
crm:execute |
crm.manage |
— |
leads_import_prepare |
Request approval: Import leads | POST /api/v1/approvals/leads-import |
crm:execute |
crm.manage |
— |
leads_import |
Import leads | POST /api/v1/approvals/{id}/leads-import |
crm:execute |
crm.manage |
— |
sales_overview_export_prepare |
Request approval: Export the Sales overview | POST /api/v1/approvals/sales-overview-export |
crm:execute |
crm.manage |
— |
sales_overview_export |
Export the Sales overview | POST /api/v1/approvals/{id}/sales-overview-export |
crm:execute |
crm.manage |
— |
leads_privacy_report_prepare |
Request approval: Make a lead’s personal-data report | POST /api/v1/approvals/leads-privacy-report/{id} |
crm:execute |
crm.manage |
— |
leads_privacy_report |
Make a lead’s personal-data report | POST /api/v1/approvals/{id}/leads-privacy-report |
crm:execute |
crm.manage |
— |
Projects
| Tool | What it does | HTTP | Grant | Permission | Customer workspace |
|---|---|---|---|---|---|
assignees_search |
Find assignees | GET /api/v1/assignees |
engagements:read |
projects.use or projects.manage |
— |
decisions_list |
List customer decisions | GET /api/v1/decisions |
engagements:read |
projects.use or projects.manage |
— |
decisions_get |
Read a customer decision | GET /api/v1/decisions/{id} |
engagements:read |
projects.use or projects.manage |
— |
decisions_prepare |
Prepare a proof or job page | POST /api/v1/decisions/prepare |
engagements:prepare |
projects.use or projects.manage |
— |
decisions_options |
Find records for a customer page | GET /api/v1/decisions/options |
engagements:read |
projects.use or projects.manage |
— |
engagements_list |
List projects | GET /api/v1/engagements |
engagements:read |
customers.view or projects.use or projects.manage |
— |
engagements_get |
Read a project | GET /api/v1/engagements/{id} |
engagements:read |
customers.view or projects.use or projects.manage |
— |
engagements_create |
Add a project | POST /api/v1/engagements |
engagements:prepare |
invoices.manage |
— |
engagements_milestone |
Plan a milestone | POST /api/v1/engagements/{id}/milestones |
engagements:prepare |
invoices.manage |
— |
engagements_close |
Close or reopen a project | POST /api/v1/engagements/{id}/state |
engagements:prepare |
invoices.manage |
— |
engagements_preview_invoice |
Preview a project invoice | POST /api/v1/engagements/{id}/invoice-preview |
engagements:read |
invoices.manage |
— |
engagements_prepare_invoice |
Prepare a project invoice draft | POST /api/v1/engagements/{id}/invoice-draft |
engagements:prepare |
invoices.manage |
— |
tasks_list |
List tasks within the current person’s scope | GET /api/v1/tasks |
engagements:read |
projects.use or projects.manage |
— |
tasks_get |
Read one task, its current status and version | GET /api/v1/tasks/{id} |
engagements:read |
projects.use or projects.manage |
— |
tasks_create |
Create a task with a stable request key | POST /api/v1/tasks |
engagements:prepare |
projects.use or projects.manage |
— |
tasks_update |
Edit a task at its current version | POST /api/v1/tasks/{id} |
engagements:prepare |
projects.use or projects.manage |
— |
tasks_complete |
Complete a task through its completed status | POST /api/v1/tasks/{id}/complete |
engagements:prepare |
projects.use or projects.manage |
— |
time_list |
List permitted time entries | GET /api/v1/time |
engagements:read |
projects.use or projects.manage |
— |
time_log |
Log exact minutes for the permitted person and work | POST /api/v1/time |
engagements:prepare |
projects.use or projects.manage |
— |
time_start |
Start the person’s timer, stopping their previous timer | POST /api/v1/time/start |
engagements:prepare |
projects.use or projects.manage |
— |
time_stop |
Stop the person’s running timer | POST /api/v1/time/stop |
engagements:prepare |
projects.use or projects.manage |
— |
time_pause |
Pause the person’s running timer and save the time so far | POST /api/v1/time/pause |
engagements:prepare |
projects.use or projects.manage |
— |
time_resume |
Resume the person’s paused timer | POST /api/v1/time/resume |
engagements:prepare |
projects.use or projects.manage |
— |
time_dismiss |
Clear the person’s paused timer and keep the saved time | POST /api/v1/time/dismiss |
engagements:prepare |
projects.use or projects.manage |
— |
projects_unbilled |
Read unbilled project time and exact values per currency | GET /api/v1/projects/unbilled |
engagements:read |
financial_summary.view |
— |
projects_margin |
Read project margin from issued net invoices, purchases and costed time | GET /api/v1/projects/margin |
engagements:read |
financial_summary.view |
— |
projects_workload |
Read planned, logged and available time for a week | GET /api/v1/projects/workload |
engagements:read |
projects.manage |
— |
work_mine |
Read My work | GET /api/v1/work/mine |
engagements:read |
projects.use or projects.manage |
— |
work_settings |
Read the work settings | GET /api/v1/work/settings |
engagements:read |
projects.use or projects.manage |
— |
time_defaults |
Read time entry defaults | GET /api/v1/time/defaults |
engagements:read |
projects.use or projects.manage |
— |
time_timesheet |
Read a weekly timesheet | GET /api/v1/time/week |
engagements:read |
projects.use or projects.manage |
— |
time_timer |
Read the running timer | GET /api/v1/time/timer |
engagements:read |
projects.use or projects.manage |
— |
tasks_statuses |
Read task statuses | GET /api/v1/tasks/statuses |
engagements:read |
projects.use or projects.manage |
— |
engagements_scope |
Record a project scope | POST /api/v1/engagements/{id}/scope |
engagements:prepare |
projects.manage |
— |
engagements_milestone_state |
Change a milestone state | POST /api/v1/engagements/{id}/milestones/state |
engagements:prepare |
projects.manage |
— |
engagements_settings |
Change project settings | POST /api/v1/engagements/{id}/settings |
engagements:prepare |
projects.manage |
— |
engagements_import_quote_lines |
Copy quote lines into a project | POST /api/v1/engagements/{id}/quote-lines |
engagements:prepare |
projects.manage |
— |
tasks_statuses_save |
Change task statuses | POST /api/v1/tasks/statuses |
engagements:prepare |
projects.manage |
— |
tasks_move |
Move a task to a status | POST /api/v1/tasks/{id}/status |
engagements:prepare |
projects.use or projects.manage |
— |
tasks_reopen |
Reopen a task | POST /api/v1/tasks/{id}/reopen |
engagements:prepare |
projects.use or projects.manage |
— |
tasks_assign |
Assign a task | POST /api/v1/tasks/{id}/assignee |
engagements:prepare |
projects.use or projects.manage |
— |
tasks_reschedule |
Change a task’s dates | POST /api/v1/tasks/{id}/dates |
engagements:prepare |
projects.use or projects.manage |
— |
tasks_watch |
Watch a task | POST /api/v1/tasks/{id}/watch |
engagements:prepare |
projects.use or projects.manage |
— |
tasks_link |
Set a task’s blockers | POST /api/v1/tasks/{id}/links |
engagements:prepare |
projects.use or projects.manage |
— |
tasks_archive |
Archive or restore a task | POST /api/v1/tasks/{id}/archive |
engagements:prepare |
projects.use or projects.manage |
— |
tasks_tag |
Tag a task | POST /api/v1/tasks/{id}/tags |
engagements:prepare |
projects.use or projects.manage |
— |
tasks_attach_project |
Move a task into a project | POST /api/v1/tasks/{id}/project |
engagements:prepare |
projects.use or projects.manage |
— |
tasks_from_card |
Turn a card into a task | POST /api/v1/cards/{id}/task |
engagements:prepare |
projects.use or projects.manage |
— |
time_update |
Correct a time entry | PUT /api/v1/time/{id} |
engagements:prepare |
projects.use or projects.manage |
— |
time_delete |
Delete a time entry | POST /api/v1/time/{id}/delete |
engagements:prepare |
projects.use or projects.manage |
— |
time_cell |
Set a timesheet cell | POST /api/v1/time/cell |
engagements:prepare |
projects.use or projects.manage |
— |
views_engagement |
View projects | GET /api/v1/views/engagement |
engagements:read |
projects.use or projects.manage or customers.view |
— |
views_task |
View tasks | GET /api/v1/views/task |
engagements:read |
projects.use or projects.manage |
— |
views_time_entry |
View time entries | GET /api/v1/views/time_entry |
engagements:read |
projects.use or projects.manage |
— |
views_task_bulk |
Change many tasks | POST /api/v1/views/task/bulk |
engagements:prepare |
projects.use or projects.manage |
— |
views_task_move |
Move a task on the board | POST /api/v1/views/task/move/{id} |
engagements:prepare |
projects.use or projects.manage |
— |
decisions_job_move_prepare |
Request approval: Move a job to another stage | POST /api/v1/approvals/decisions-job-move/{id} |
engagements:execute |
projects.manage |
— |
decisions_job_move |
Move a job to another stage | POST /api/v1/approvals/{id}/decisions-job-move |
engagements:execute |
projects.manage |
— |
decisions_job_close_prepare |
Request approval: Close or reopen a job page | POST /api/v1/approvals/decisions-job-close/{id} |
engagements:execute |
projects.manage |
— |
decisions_job_close |
Close or reopen a job page | POST /api/v1/approvals/{id}/decisions-job-close |
engagements:execute |
projects.manage |
— |
decisions_question_ask_prepare |
Request approval: Ask a customer a question | POST /api/v1/approvals/decisions-question-ask/{id} |
engagements:execute |
projects.manage |
— |
decisions_question_ask |
Ask a customer a question | POST /api/v1/approvals/{id}/decisions-question-ask |
engagements:execute |
projects.manage |
— |
decisions_question_reopen_prepare |
Request approval: Ask a question again | POST /api/v1/approvals/decisions-question-reopen/{id} |
engagements:execute |
projects.manage |
— |
decisions_question_reopen |
Ask a question again | POST /api/v1/approvals/{id}/decisions-question-reopen |
engagements:execute |
projects.manage |
— |
decisions_remind_prepare |
Request approval: Remind a customer about open questions | POST /api/v1/approvals/decisions-remind/{id} |
engagements:execute |
projects.manage |
— |
decisions_remind |
Remind a customer about open questions | POST /api/v1/approvals/{id}/decisions-remind |
engagements:execute |
projects.manage |
— |
decisions_notice_retry_prepare |
Request approval: Send a customer page email again | POST /api/v1/approvals/decisions-notice-retry/{id} |
engagements:execute |
projects.manage |
— |
decisions_notice_retry |
Send a customer page email again | POST /api/v1/approvals/{id}/decisions-notice-retry |
engagements:execute |
projects.manage |
— |
projects_work_settings_prepare |
Request approval: Change work settings | POST /api/v1/approvals/projects-work-settings |
engagements:execute |
projects.manage |
— |
projects_work_settings |
Change work settings | POST /api/v1/approvals/{id}/projects-work-settings |
engagements:execute |
projects.manage |
— |
projects_report_export_prepare |
Request approval: Export a project report | POST /api/v1/approvals/projects-report-export |
engagements:execute |
projects.use |
— |
projects_report_export |
Export a project report | POST /api/v1/approvals/{id}/projects-report-export |
engagements:execute |
projects.use |
— |
projects_time_export_prepare |
Request approval: Export tracked time | POST /api/v1/approvals/projects-time-export |
engagements:execute |
projects.use |
— |
projects_time_export |
Export tracked time | POST /api/v1/approvals/{id}/projects-time-export |
engagements:execute |
projects.use |
— |
projects_workload_export_prepare |
Request approval: Export the workload | POST /api/v1/approvals/projects-workload-export |
engagements:execute |
projects.manage |
— |
projects_workload_export |
Export the workload | POST /api/v1/approvals/{id}/projects-workload-export |
engagements:execute |
projects.manage |
— |
Boards
| Tool | What it does | HTTP | Grant | Permission | Customer workspace |
|---|---|---|---|---|---|
boards_list |
Find boards | GET /api/v1/boards |
boards:read |
boards.use |
— |
boards_get |
Read a board | GET /api/v1/boards/{id} |
boards:read |
boards.use |
— |
cards_list |
Read a list’s cards | GET /api/v1/board-lists/{id}/cards |
boards:read |
boards.use |
— |
cards_get |
Read a card | GET /api/v1/board-cards/{id} |
boards:read |
boards.use |
— |
boards_prepare |
Prepare a board or card change | POST /api/v1/boards/prepare |
boards:prepare |
boards.use |
— |
cards_mine |
Read my cards | GET /api/v1/cards/mine |
boards:read |
boards.use |
— |
boards_backlinks |
Find cards that link a record | GET /api/v1/boards/backlinks |
boards:read |
boards.use |
— |
boards_source_url |
Resolve a record link | GET /api/v1/boards/source |
boards:read |
boards.use |
— |
boards_directory |
List every board | GET /api/v1/boards/directory |
boards:read |
boards.use |
— |
boards_update |
Change board settings | POST /api/v1/boards/{id}/settings |
boards:prepare |
boards.use |
— |
boards_label |
Add or change a board label | POST /api/v1/boards/{id}/labels |
boards:prepare |
boards.use |
— |
boards_create |
Create a board | POST /api/v1/boards |
boards:prepare |
boards.use |
— |
boards_copy |
Copy a board | POST /api/v1/boards/{id}/copy |
boards:prepare |
boards.use |
— |
boards_remove_examples |
Remove sample cards | POST /api/v1/boards/{id}/examples/remove |
boards:prepare |
boards.use |
— |
boards_upload_prepare |
Start a board upload | POST /api/v1/boards/uploads |
boards:prepare |
boards.use |
— |
boards_background |
Set a board background | POST /api/v1/boards/{id}/background |
boards:prepare |
boards.use |
— |
boards_import_preview |
Check a Trello export | POST /api/v1/boards/import/preview |
boards:prepare |
boards.use |
— |
boards_import |
Import a Trello board | POST /api/v1/boards/import |
boards:prepare |
boards.use |
— |
cards_update |
Change a card | POST /api/v1/board-cards/{id} |
boards:prepare |
boards.use |
— |
cards_participate |
Join, watch or react to a card | POST /api/v1/board-cards/{id}/participate |
boards:prepare |
boards.use |
— |
cards_copy |
Copy a card | POST /api/v1/board-cards/{id}/copy |
boards:prepare |
boards.use |
— |
cards_undo |
Undo a card change | POST /api/v1/board-undo/{id} |
boards:prepare |
boards.use |
— |
cards_attach_files |
Attach files to a card | POST /api/v1/board-cards/{id}/files |
boards:prepare |
boards.use |
— |
cards_drop_file |
Add a card for a file | POST /api/v1/boards/{id}/drop |
boards:prepare |
boards.use |
— |
lists_create |
Add a list | POST /api/v1/boards/{id}/lists |
boards:prepare |
boards.use |
— |
lists_update |
Change a list | POST /api/v1/board-lists/{id} |
boards:prepare |
boards.use |
— |
lists_copy |
Copy a list | POST /api/v1/board-lists/{id}/copy |
boards:prepare |
boards.use |
— |
lists_move_all |
Move all cards of a list | POST /api/v1/board-lists/{id}/move-all |
boards:prepare |
boards.use |
— |
boards_audience_prepare |
Request approval: Change who can open a board | POST /api/v1/approvals/boards-audience/{id} |
boards:execute |
boards.use |
— |
boards_audience |
Change who can open a board | POST /api/v1/approvals/{id}/boards-audience |
boards:execute |
boards.use |
— |
boards_member_role_prepare |
Request approval: Change a board member | POST /api/v1/approvals/boards-member-role/{id} |
boards:execute |
boards.use |
— |
boards_member_role |
Change a board member | POST /api/v1/approvals/{id}/boards-member-role |
boards:execute |
boards.use |
— |
boards_join_admin_prepare |
Request approval: Join a board as admin | POST /api/v1/approvals/boards-join-admin/{id} |
boards:execute |
boards.manage |
— |
boards_join_admin |
Join a board as admin | POST /api/v1/approvals/{id}/boards-join-admin |
boards:execute |
boards.manage |
— |
boards_export_prepare |
Request approval: Export a board | POST /api/v1/approvals/boards-export/{id} |
boards:execute |
boards.use |
— |
boards_export |
Export a board | POST /api/v1/approvals/{id}/boards-export |
boards:execute |
boards.use |
— |
boards_delete_prepare |
Request approval: Delete a board | POST /api/v1/approvals/boards-delete/{id} |
boards:execute |
boards.use |
— |
boards_delete |
Delete a board | POST /api/v1/approvals/{id}/boards-delete |
boards:execute |
boards.use |
— |
Docs
| Tool | What it does | HTTP | Grant | Permission | Customer workspace |
|---|---|---|---|---|---|
docs_list |
All docs · Docs | GET /api/v1/docs |
docs:read |
docs.view |
— |
docs_get |
Open · Docs | GET /api/v1/docs/{id} |
docs:read |
docs.view |
— |
docs_templates |
Templates · Docs | GET /api/v1/docs/templates |
docs:read |
docs.view |
— |
docs_template |
Start from a template · Docs | GET /api/v1/docs/{id}/template |
docs:read |
docs.manage |
— |
docs_source |
Linked record · Docs | GET /api/v1/docs/source |
docs:read |
docs.manage |
— |
docs_create |
Create doc · Docs | POST /api/v1/docs |
docs:prepare |
docs.manage |
— |
docs_metadata |
Edit details · Docs | PATCH /api/v1/docs/{id}/metadata |
docs:prepare |
docs.manage |
— |
docs_folders |
All folders · Docs | GET /api/v1/docs/folders |
docs:read |
docs.view |
— |
docs_folder_create |
Create folder · Docs | POST /api/v1/docs/folders |
docs:prepare |
docs.manage |
— |
docs_folder_rename |
Rename folder · Docs | PATCH /api/v1/docs/folders/{id} |
docs:prepare |
docs.manage |
— |
docs_folder_remove |
Remove folder · Docs | DELETE /api/v1/docs/folders/{id} |
docs:prepare |
docs.manage |
— |
docs_writer_acquire |
Edit · Docs | POST /api/v1/docs/{id}/writer |
docs:prepare |
docs.manage |
— |
docs_writer_renew |
Renew editing session · Docs | POST /api/v1/docs/{id}/writer/renew |
docs:prepare |
docs.manage |
— |
docs_writer_release |
Finish editing · Docs | POST /api/v1/docs/{id}/writer/release |
docs:prepare |
docs.manage |
— |
docs_save |
Save now · Docs | PUT /api/v1/docs/{id}/content |
docs:prepare |
docs.manage |
— |
docs_history |
History · Docs | GET /api/v1/docs/{id}/history |
docs:read |
docs.view |
— |
docs_version |
Version · Docs | GET /api/v1/docs/{id}/version |
docs:read |
docs.view |
— |
docs_restore |
Restore as new version · Docs | POST /api/v1/docs/{id}/restore |
docs:prepare |
docs.manage |
— |
docs_edition |
Edition · Docs | GET /api/v1/docs/{id}/edition |
docs:read |
docs.view |
— |
docs_export |
Export PDF · Docs | POST /api/v1/docs/{id}/exports |
docs:prepare |
docs.view |
— |
docs_artifact |
Download PDF · Docs | GET /api/v1/docs/artifacts/{id} |
docs:read |
docs.view |
— |
docs_revoke_share |
Revoke link · Docs | POST /api/v1/docs/{id}/shares/revoke |
docs:prepare |
docs.share |
— |
docs_merge |
Insert a field value · Docs | POST /api/v1/docs/merge |
docs:read |
docs.manage |
— |
docs_embed |
Live record · Docs | GET /api/v1/docs/embed |
docs:read |
docs.manage |
— |
docs_image |
Find an image in Files · Docs | GET /api/v1/docs/image |
docs:read |
docs.manage |
— |
docs_image_upload |
Upload image · Docs | POST /api/v1/docs/{id}/images |
docs:prepare |
docs.manage |
— |
docs_approve_prepare |
Review: Approve edition · Docs | POST /api/v1/approvals/docs-approve/{id} |
docs:execute |
docs.approve |
— |
docs_approve |
Approve edition · Docs | POST /api/v1/approvals/{id}/docs-approve |
docs:execute |
docs.approve |
— |
docs_share_prepare |
Review: Create recipient link · Docs | POST /api/v1/approvals/docs-share/{id} |
docs:execute |
docs.share |
— |
docs_share |
Create recipient link · Docs | POST /api/v1/approvals/{id}/docs-share |
docs:execute |
docs.share |
— |
docs_access_prepare |
Review: People and teams · Docs | POST /api/v1/approvals/docs-access/{id} |
docs:execute |
docs.manage |
— |
docs_access |
People and teams · Docs | POST /api/v1/approvals/{id}/docs-access |
docs:execute |
docs.manage |
— |
docs_update_prepare |
Review: Owner / Linked record · Docs | POST /api/v1/approvals/docs-update/{id} |
docs:execute |
docs.manage |
— |
docs_update |
Owner / Linked record · Docs | POST /api/v1/approvals/{id}/docs-update |
docs:execute |
docs.manage |
— |
docs_writer_end_prepare |
Review: End editing session · Docs | POST /api/v1/approvals/docs-writer-end/{id} |
docs:execute |
docs.manage |
— |
docs_writer_end |
End editing session · Docs | POST /api/v1/approvals/{id}/docs-writer-end |
docs:execute |
docs.manage |
— |
Signatures
| Tool | What it does | HTTP | Grant | Permission | Customer workspace |
|---|---|---|---|---|---|
signatures_list |
List signature requests | GET /api/v1/signatures |
signatures:read |
docs.view or invoices.view or invoices.view_own |
— |
signatures_get |
Read signature request | GET /api/v1/signatures/{id} |
signatures:read |
docs.view or invoices.view or invoices.view_own |
— |
signatures_create |
Create signature draft | POST /api/v1/signatures |
signatures:prepare |
docs.share or invoices.manage |
— |
signatures_update |
Save signature draft | PUT /api/v1/signatures/{id} |
signatures:prepare |
docs.share or invoices.manage |
— |
signatures_void |
Void signature request | DELETE /api/v1/signatures/{id} |
signatures:prepare |
docs.share or invoices.manage |
— |
signatures_templates |
Read role field templates | GET /api/v1/signatures/templates |
signatures:read |
docs.share or invoices.manage |
— |
signatures_template_save |
Save role field template | POST /api/v1/signatures/templates |
signatures:prepare |
docs.share or invoices.manage |
— |
signatures_artifact |
Download signature PDF | GET /api/v1/signatures/{id}/artifact |
signatures:read |
docs.view or invoices.view or invoices.view_own |
— |
signatures_send_prepare |
Prepare a signature request for approval | POST /api/v1/approvals/signatures-send/{id} |
signatures:execute |
docs.share or invoices.manage |
— |
signatures_send |
Send request | POST /api/v1/approvals/{id}/signatures-send |
signatures:execute |
docs.share or invoices.manage |
— |
signatures_reissue_prepare |
Prepare a signing link reissue for approval | POST /api/v1/approvals/signatures-reissue/{id} |
signatures:execute |
docs.share or invoices.manage |
— |
signatures_reissue |
Reissue link | POST /api/v1/approvals/{id}/signatures-reissue |
signatures:execute |
docs.share or invoices.manage |
— |
Calendar
| Tool | What it does | HTTP | Grant | Permission | Customer workspace |
|---|---|---|---|---|---|
calendar_read |
Read a calendar view | GET /api/v1/calendar |
calendar:read |
calendar.use |
— |
calendar_calendars |
Read available calendars | GET /api/v1/calendar/calendars |
calendar:read |
calendar.use |
— |
calendar_calendar_get |
Read one calendar | GET /api/v1/calendar/calendars/{id} |
calendar:read |
calendar.use |
— |
calendar_calendar_create |
Create a calendar | POST /api/v1/calendar/calendars |
calendar:prepare |
calendar.use |
— |
calendar_calendar_update |
Change a calendar | PUT /api/v1/calendar/calendars/{id} |
calendar:prepare |
calendar.use |
— |
calendar_calendar_archive |
Archive a calendar | POST /api/v1/calendar/calendars/{id}/archive |
calendar:prepare |
calendar.use |
— |
calendar_event_get |
Read one calendar event | GET /api/v1/calendar/events/{id} |
calendar:read |
calendar.use |
— |
calendar_event_prepare |
Preview a calendar event | POST /api/v1/calendar/events/preview |
calendar:read |
calendar.use |
— |
calendar_event_create |
Create a calendar event | POST /api/v1/calendar/events |
calendar:prepare |
calendar.use |
— |
calendar_event_update |
Change a calendar event | PUT /api/v1/calendar/events/{id} |
calendar:prepare |
calendar.use |
— |
calendar_event_cancel |
Cancel a calendar event | POST /api/v1/calendar/events/{id}/cancel |
calendar:prepare |
calendar.use |
— |
calendar_event_exception |
Change one calendar occurrence | POST /api/v1/calendar/events/{id}/exception |
calendar:prepare |
calendar.use |
— |
calendar_lookups |
Find calendar people and teams | GET /api/v1/calendar/lookups |
calendar:read |
calendar.use |
— |
calendar_import |
Import calendar events | POST /api/v1/calendar/import |
calendar:prepare |
calendar.use |
— |
calendar_subscriptions |
Read your calendar subscriptions | GET /api/v1/calendar/subscriptions |
calendar:read |
calendar.use |
— |
calendar_subscription_revoke |
Revoke a calendar subscription | DELETE /api/v1/calendar/subscriptions/{id} |
calendar:prepare |
calendar.use |
— |
calendar_invitation_review |
Prepare a calendar invitation review | POST /api/v1/calendar/events/{id}/invitations/prepare |
calendar:prepare |
calendar.use |
— |
calendar_invitation_get |
Read a calendar invitation review | GET /api/v1/calendar/invitations/{id} |
calendar:read |
calendar.use |
— |
calendar_invitation_status |
Read calendar invitation delivery results | GET /api/v1/calendar/invitations/{id}/status |
calendar:read |
calendar.use |
— |
calendar_export_prepare |
Request approval to export a calendar view | POST /api/v1/approvals/calendar-export |
calendar:execute |
calendar.use |
— |
calendar_export |
Export a calendar view | POST /api/v1/approvals/{id}/calendar-export |
calendar:execute |
calendar.use |
— |
calendar_feed_create_prepare |
Request approval for a calendar subscription | POST /api/v1/approvals/calendar-feed-create |
calendar:execute |
calendar.use |
— |
calendar_feed_create |
Create a calendar subscription | POST /api/v1/approvals/{id}/calendar-feed-create |
calendar:execute |
calendar.use |
— |
calendar_invite_prepare |
Request approval for reviewed calendar invitations | POST /api/v1/approvals/calendar-invite/{id} |
calendar:execute |
calendar.use |
— |
calendar_invite |
Send reviewed calendar invitations | POST /api/v1/approvals/{id}/calendar-invite |
calendar:execute |
calendar.use |
— |
calendar_mail_retry_prepare |
Request approval to retry a calendar invitation | POST /api/v1/approvals/calendar-mail-retry/{id} |
calendar:execute |
calendar.use |
— |
calendar_mail_retry |
Retry a calendar invitation | POST /api/v1/approvals/{id}/calendar-mail-retry |
calendar:execute |
calendar.use |
— |
views_work_calendar |
Read a view of calendar containers | GET /api/v1/views/work_calendar |
calendar:read |
calendar.use |
— |
views_calendar_event |
Read a view of calendar events | GET /api/v1/views/calendar_event |
calendar:read |
calendar.use |
— |
Automations
| Tool | What it does | HTTP | Grant | Permission | Customer workspace |
|---|---|---|---|---|---|
automations_catalog |
Read automation action catalogue | GET /api/v1/automations/catalog |
automations:read |
automations.use |
— |
automations_rules |
Read owned automation rule register | GET /api/v1/automations/rules |
automations:read |
automations.use |
— |
automations_rule_get |
Read one owned automation rule | GET /api/v1/automations/rules/{id} |
automations:read |
automations.use |
— |
automations_rule_create |
Create an inactive automation rule | POST /api/v1/automations/rules |
automations:prepare |
automations.manage |
— |
automations_rule_update |
Replace an automation rule graph | PUT /api/v1/automations/rules/{id} |
automations:prepare |
automations.manage |
— |
automations_activation |
Change automation rule activation | POST /api/v1/automations/rules/{id}/activation |
automations:prepare |
automations.manage |
— |
automations_trust_revoke |
Revoke trust on an automation rule | POST /api/v1/automations/rules/{id}/trust-revoke |
automations:prepare |
automations.manage |
— |
automations_starting_points |
Read the automation starting points | GET /api/v1/automations/starting-points |
automations:read |
automations.use |
— |
automations_message_get |
Read one follow-up message delivery | GET /api/v1/automations/messages/{id} |
automations:read |
automations.use |
— |
automations_stop |
Change automation operational stop | POST /api/v1/automations/rules/{id}/stop |
automations:prepare |
automations.manage |
— |
automations_runs |
Read recent automation runs | GET /api/v1/automations/rules/{id}/runs |
automations:read |
automations.use |
— |
automations_run_get |
Read one current automation run | GET /api/v1/automations/runs/{id} |
automations:read |
automations.use |
— |
automations_run_retry |
Retry a failed ordinary automation run | POST /api/v1/automations/runs/{id}/retry |
automations:prepare |
automations.manage |
— |
automations_endpoints |
Read owned webhook endpoints | GET /api/v1/automations/endpoints |
automations:read |
automations.manage |
— |
automations_endpoint_get |
Read one webhook endpoint | GET /api/v1/automations/endpoints/{id} |
automations:read |
automations.manage |
— |
automations_endpoint_create |
Create a webhook endpoint and signing key | POST /api/v1/automations/endpoints |
automations:prepare |
automations.manage |
— |
automations_endpoint_rotate |
Rotate a webhook endpoint signing key | POST /api/v1/automations/endpoints/{id}/rotate |
automations:prepare |
automations.manage |
— |
automations_webhook_get |
Read current webhook delivery evidence | GET /api/v1/automations/webhooks/{id} |
automations:read |
automations.manage |
— |
automations_webhook_recovery_prepare |
Review another attempt | POST /api/v1/automations/webhooks/{id}/recovery |
automations:execute |
automations.manage |
— |
automations_trust_prepare |
Request approval: Trust an automation rule | POST /api/v1/approvals/automations-trust/{id} |
automations:execute |
automations.manage |
— |
automations_trust |
Trust an automation rule | POST /api/v1/approvals/{id}/automations-trust |
automations:execute |
automations.manage |
— |
automations_webhook_send_prepare |
Request approval to send a webhook | POST /api/v1/approvals/automations-webhook-send/{id} |
automations:execute |
automations.manage |
— |
automations_webhook_send |
Send a reviewed webhook | POST /api/v1/approvals/{id}/automations-webhook-send |
automations:execute |
automations.manage |
— |
automations_webhook_retry_prepare |
Request approval to retry a webhook | POST /api/v1/approvals/automations-webhook-retry/{id} |
automations:execute |
automations.manage |
— |
automations_webhook_retry |
Retry a reviewed webhook | POST /api/v1/approvals/{id}/automations-webhook-retry |
automations:execute |
automations.manage |
— |
views_automation_rule |
Query the automation rule view | GET /api/v1/views/automation_rule |
automations:read |
automations.use |
— |
views_automation_endpoint |
Query the webhook endpoint view | GET /api/v1/views/automation_endpoint |
automations:read |
automations.use |
— |
Purchases
| Tool | What it does | HTTP | Grant | Permission | Customer workspace |
|---|---|---|---|---|---|
purchase_categories_list |
List purchase categories | GET /api/v1/purchase-categories |
purchases:read |
purchases.view or purchases.view_own or purchases.manage |
— |
suppliers_list |
List suppliers | GET /api/v1/suppliers |
purchases:read |
purchases.manage or purchases.view |
— |
purchases_list |
List purchases | GET /api/v1/purchases |
purchases:read |
purchases.view or purchases.view_own |
— |
purchases_get |
Read a purchase | GET /api/v1/purchases/{id} |
purchases:read |
purchases.view or purchases.view_own |
— |
purchases_create |
Record a purchase | POST /api/v1/purchases |
purchases:prepare |
purchases.manage |
— |
purchases_update |
Change a purchase | PUT /api/v1/purchases/{id} |
purchases:prepare |
purchases.manage |
— |
purchases_receipt_prepare |
Start a receipt upload | POST /api/v1/purchases/receipts |
purchases:prepare |
purchases.manage |
— |
purchases_attach_files |
Attach receipts to a purchase | POST /api/v1/purchases/{id}/files |
purchases:prepare |
purchases.manage |
— |
purchases_replace_file |
Replace a receipt | POST /api/v1/purchases/{id}/files/replace |
purchases:prepare |
purchases.manage |
— |
purchases_file |
Download a receipt | GET /api/v1/purchases/{id}/file |
purchases:read |
purchases.view or purchases.view_own |
— |
periods_get |
Read a tax period | GET /api/v1/periods |
purchases:read |
financial_summary.view |
— |
views_purchase |
View purchases | GET /api/v1/views/purchase |
purchases:read |
purchases.view or purchases.view_own |
— |
purchases_payment_prepare |
Request approval: Record that a purchase was paid | POST /api/v1/approvals/purchases-payment/{id} |
purchases:execute |
purchases.manage |
— |
purchases_payment |
Record that a purchase was paid | POST /api/v1/approvals/{id}/purchases-payment |
purchases:execute |
purchases.manage |
— |
purchases_void_prepare |
Request approval: Void a purchase | POST /api/v1/approvals/purchases-void/{id} |
purchases:execute |
purchases.manage |
— |
purchases_void |
Void a purchase | POST /api/v1/approvals/{id}/purchases-void |
purchases:execute |
purchases.manage |
— |
purchases_category_create_prepare |
Request approval: Add a purchase category | POST /api/v1/approvals/purchases-category-create |
purchases:execute |
purchases.manage |
— |
purchases_category_create |
Add a purchase category | POST /api/v1/approvals/{id}/purchases-category-create |
purchases:execute |
purchases.manage |
— |
purchases_category_update_prepare |
Request approval: Change a purchase category | POST /api/v1/approvals/purchases-category-update/{id} |
purchases:execute |
purchases.manage |
— |
purchases_category_update |
Change a purchase category | POST /api/v1/approvals/{id}/purchases-category-update |
purchases:execute |
purchases.manage |
— |
purchases_period_export_prepare |
Request approval: Export a tax period | POST /api/v1/approvals/purchases-period-export |
purchases:execute |
purchases.manage |
— |
purchases_period_export |
Export a tax period | POST /api/v1/approvals/{id}/purchases-period-export |
purchases:execute |
purchases.manage |
— |
Items
| Tool | What it does | HTTP | Grant | Permission | Customer workspace |
|---|---|---|---|---|---|
item_categories_list |
List item categories | GET /api/v1/item-categories |
items:read |
items.view or items.manage |
— |
menu-items_get |
Read menu item details | GET /api/v1/menu-items/{id} |
items:read |
items.manage |
widget.menu |
menu-items_prepare |
Prepare menu item details | POST /api/v1/menu-items/prepare |
items:prepare |
items.manage |
widget.menu |
items_list |
List catalogue items | GET /api/v1/items |
items:read |
items.view |
— |
items_get |
Read an item | GET /api/v1/items/{id} |
items:read |
items.manage |
— |
items_create |
Add an item | POST /api/v1/items |
items:prepare |
items.manage |
— |
items_update |
Change an item | PUT /api/v1/items/{id} |
items:prepare |
items.manage |
— |
catalogue_get |
Read a catalogue product | GET /api/v1/items/{id}/catalogue |
items:read |
items.view |
shop.stock |
catalogue_assets |
Find permitted catalogue files | GET /api/v1/items/{id}/assets |
items:read |
items.manage |
— |
catalogue_image |
Read an authorized product image | GET /api/v1/items/{id}/image |
items:read |
items.view |
shop.stock |
catalogue_save |
Save product variants and stock rules | PUT /api/v1/items/{id}/catalogue |
items:prepare |
items.manage |
shop.manage |
stock_history |
Read stock movement history | GET /api/v1/stock/{id}/history |
items:read |
items.view |
shop.stock |
stock_alerts |
Read authorized stock alert records | GET /api/v1/stock/{id}/alerts |
items:read |
items.view |
— |
catalogue_choices |
Find catalogue choices | GET /api/v1/items/catalogue-choices |
items:read |
items.view |
— |
views_item |
View items | GET /api/v1/views/item |
items:read |
items.view |
— |
views_item_bulk |
Change many items | POST /api/v1/views/item/bulk |
items:prepare |
items.manage |
— |
views_item_move |
Move an item on the board | POST /api/v1/views/item/move/{id} |
items:prepare |
items.manage |
— |
items_delete_prepare |
Request approval: Delete an item | POST /api/v1/approvals/items-delete/{id} |
items:execute |
items.manage |
— |
items_delete |
Delete an item | POST /api/v1/approvals/{id}/items-delete |
items:execute |
items.manage |
— |
items_import_prepare |
Request approval: Import items | POST /api/v1/approvals/items-import |
items:execute |
items.manage |
— |
items_import |
Import items | POST /api/v1/approvals/{id}/items-import |
items:execute |
items.manage |
— |
items_export_prepare |
Request approval: Export items | POST /api/v1/approvals/items-export |
items:execute |
items.view |
— |
items_export |
Export items | POST /api/v1/approvals/{id}/items-export |
items:execute |
items.view |
— |
stock_change_prepare |
Request approval: Change stock | POST /api/v1/approvals/stock-change/{id} |
items:execute |
items.manage |
shop.stock |
stock_change |
Change stock | POST /api/v1/approvals/{id}/stock-change |
items:execute |
items.manage |
shop.stock |
catalogue_policy_prepare |
Request approval: Change backorder policy | POST /api/v1/approvals/catalogue-policy/{id} |
items:execute |
items.manage |
shop.manage |
catalogue_policy |
Change backorder policy | POST /api/v1/approvals/{id}/catalogue-policy |
items:execute |
items.manage |
shop.manage |
catalogue_import_prepare |
Request approval: Import catalogue | POST /api/v1/approvals/catalogue-import |
items:execute |
items.manage |
— |
catalogue_import |
Import catalogue | POST /api/v1/approvals/{id}/catalogue-import |
items:execute |
items.manage |
— |
catalogue_export_prepare |
Request approval: Export catalogue | POST /api/v1/approvals/catalogue-export |
items:execute |
items.view |
— |
catalogue_export |
Export catalogue | POST /api/v1/approvals/{id}/catalogue-export |
items:execute |
items.view |
— |
stock_alert_privacy_lookup_prepare |
Request approval: Find a stock-alert subscriber | POST /api/v1/approvals/stock-alert-privacy-lookup |
items:execute |
items.manage |
— |
stock_alert_privacy_lookup |
Find a stock-alert subscriber | POST /api/v1/approvals/{id}/stock-alert-privacy-lookup |
items:execute |
items.manage |
— |
stock_alert_privacy_report_prepare |
Request approval: Report a stock-alert subscriber’s data | POST /api/v1/approvals/stock-alert-privacy-report |
items:execute |
items.manage |
— |
stock_alert_privacy_report |
Report a stock-alert subscriber’s data | POST /api/v1/approvals/{id}/stock-alert-privacy-report |
items:execute |
items.manage |
— |
stock_alert_privacy_erase_prepare |
Request approval: Erase a stock-alert subscriber’s data | POST /api/v1/approvals/stock-alert-privacy-erase |
items:execute |
items.manage |
— |
stock_alert_privacy_erase |
Erase a stock-alert subscriber’s data | POST /api/v1/approvals/{id}/stock-alert-privacy-erase |
items:execute |
items.manage |
— |
stock_alert_retry_prepare |
Request approval: Retry a stock-alert email | POST /api/v1/approvals/stock-alert-retry |
items:execute |
items.manage |
— |
stock_alert_retry |
Retry a stock-alert email | POST /api/v1/approvals/{id}/stock-alert-retry |
items:execute |
items.manage |
— |
Orders
| Tool | What it does | HTTP | Grant | Permission | Customer workspace |
|---|---|---|---|---|---|
orders_list |
List orders | GET /api/v1/orders |
orders:read |
orders.view or orders.view_own |
— |
orders_get |
Read an order | GET /api/v1/orders/{id} |
orders:read |
orders.view or orders.view_own |
shop.orders |
orders_quote |
Review order totals | GET /api/v1/orders/{id}/quote |
orders:read |
orders.manage |
— |
orders_save |
Save an order draft | POST /api/v1/orders/drafts |
orders:prepare |
orders.manage |
— |
orders_return_quote |
Review a return credit | GET /api/v1/orders/{id}/return-quote |
orders:read |
orders.manage |
shop.orders |
shipping_methods |
Read shipping methods | GET /api/v1/orders/shipping-methods |
orders:read |
orders.view or orders.view_own |
shop.manage |
views_order |
Query order views | GET /api/v1/views/order |
orders:read |
orders.view or orders.view_own |
— |
orders_place_prepare |
Request approval: Place order | POST /api/v1/approvals/orders-place/{id} |
orders:execute |
orders.manage |
— |
orders_place |
Place order | POST /api/v1/approvals/{id}/orders-place |
orders:execute |
orders.manage |
— |
orders_cancel_prepare |
Request approval: Cancel order | POST /api/v1/approvals/orders-cancel/{id} |
orders:execute |
orders.manage |
shop.orders |
orders_cancel |
Cancel order | POST /api/v1/approvals/{id}/orders-cancel |
orders:execute |
orders.manage |
shop.orders |
orders_remainder_release_prepare |
Request approval: Close unshipped remainder | POST /api/v1/approvals/orders-remainder-release/{id} |
orders:execute |
orders.manage |
shop.orders |
orders_remainder_release |
Close unshipped remainder | POST /api/v1/approvals/{id}/orders-remainder-release |
orders:execute |
orders.manage |
shop.orders |
orders_payment_prepare |
Request approval: Record payment | POST /api/v1/approvals/orders-payment/{id} |
orders:execute |
orders.manage |
— |
orders_payment |
Record payment | POST /api/v1/approvals/{id}/orders-payment |
orders:execute |
orders.manage |
— |
orders_shipment_create_prepare |
Request approval: Create fulfilment | POST /api/v1/approvals/orders-shipment-create/{id} |
orders:execute |
orders.manage |
shop.orders |
orders_shipment_create |
Create fulfilment | POST /api/v1/approvals/{id}/orders-shipment-create |
orders:execute |
orders.manage |
shop.orders |
orders_shipment_step_prepare |
Request approval: Fulfilment | POST /api/v1/approvals/orders-shipment-step/{id} |
orders:execute |
orders.manage |
shop.orders |
orders_shipment_step |
Fulfilment | POST /api/v1/approvals/{id}/orders-shipment-step |
orders:execute |
orders.manage |
shop.orders |
orders_return_request_prepare |
Request approval: Request return | POST /api/v1/approvals/orders-return-request/{id} |
orders:execute |
orders.manage |
shop.orders |
orders_return_request |
Request return | POST /api/v1/approvals/{id}/orders-return-request |
orders:execute |
orders.manage |
shop.orders |
orders_return_step_prepare |
Request approval: Returns | POST /api/v1/approvals/orders-return-step/{id} |
orders:execute |
orders.manage |
shop.orders |
orders_return_step |
Returns | POST /api/v1/approvals/{id}/orders-return-step |
orders:execute |
orders.manage |
shop.orders |
orders_delivery_grant_prepare |
Request approval: Create download link | POST /api/v1/approvals/orders-delivery-grant/{id} |
orders:execute |
orders.manage |
shop.orders |
orders_delivery_grant |
Create download link | POST /api/v1/approvals/{id}/orders-delivery-grant |
orders:execute |
orders.manage |
shop.orders |
orders_delivery_revoke_prepare |
Request approval: Revoke download link | POST /api/v1/approvals/orders-delivery-revoke/{id} |
orders:execute |
orders.manage |
shop.orders |
orders_delivery_revoke |
Revoke download link | POST /api/v1/approvals/{id}/orders-delivery-revoke |
orders:execute |
orders.manage |
shop.orders |
orders_purchase_grant_prepare |
Request approval: Renew customer link | POST /api/v1/approvals/orders-purchase-grant/{id} |
orders:execute |
orders.manage |
shop.orders |
orders_purchase_grant |
Renew customer link | POST /api/v1/approvals/{id}/orders-purchase-grant |
orders:execute |
orders.manage |
shop.orders |
orders_purchase_revoke_prepare |
Request approval: Revoke customer link | POST /api/v1/approvals/orders-purchase-revoke/{id} |
orders:execute |
orders.manage |
shop.orders |
orders_purchase_revoke |
Revoke customer link | POST /api/v1/approvals/{id}/orders-purchase-revoke |
orders:execute |
orders.manage |
shop.orders |
orders_packing_slip_prepare |
Request approval: Packing slip | POST /api/v1/approvals/orders-packing-slip/{id} |
orders:execute |
data.export |
shop.orders |
orders_packing_slip |
Packing slip | POST /api/v1/approvals/{id}/orders-packing-slip |
orders:execute |
data.export |
shop.orders |
shipping_save_prepare |
Request approval: Save shipping method | POST /api/v1/approvals/shipping-save |
orders:execute |
orders.manage |
shop.manage |
shipping_save |
Save shipping method | POST /api/v1/approvals/{id}/shipping-save |
orders:execute |
orders.manage |
shop.manage |
Websites
| Tool | What it does | HTTP | Grant | Permission | Customer workspace |
|---|---|---|---|---|---|
websites_list |
Websites | GET /api/v1/websites |
websites:read |
websites.view |
websites.read |
websites_get |
Website | GET /api/v1/websites/{id} |
websites:read |
websites.view |
websites.read |
websites_templates |
Starting layout | GET /api/v1/websites/templates |
websites:read |
websites.view |
websites.read |
websites_blocks |
Content | GET /api/v1/websites/blocks |
websites:read |
websites.view |
websites.read |
websites_sources |
Connected sources | GET /api/v1/websites/sources |
websites:read |
websites.manage |
websites.edit |
websites_create |
Create a website | POST /api/v1/websites |
websites:prepare |
websites.manage |
websites.create |
websites_access |
Who can edit | GET /api/v1/websites/{id}/access |
websites:read |
websites.view |
websites.read |
websites_person_access |
Website access | GET /api/v1/websites/people/{id}/access |
websites:read |
websites.view |
— |
websites_image_upload |
Upload an image | POST /api/v1/websites/{id}/images |
websites:prepare |
Workspace only | websites.edit |
websites_save |
Save draft | PUT /api/v1/websites/{id}/draft |
websites:prepare |
websites.manage |
websites.edit |
websites_preview |
Page preview | POST /api/v1/websites/{id}/preview |
websites:read |
websites.view |
websites.read |
websites_history |
History | GET /api/v1/websites/{id}/history |
websites:read |
websites.view |
websites.read |
websites_version |
Saved version | GET /api/v1/websites/{id}/version |
websites:read |
websites.view |
websites.read |
websites_review |
Review publication | POST /api/v1/websites/{id}/review |
websites:read |
websites.view |
websites.read |
websites_codes |
Read page codes | GET /api/v1/websites/{id}/codes |
websites:read |
websites.view |
— |
websites_code_save |
Save a page code | POST /api/v1/websites/{id}/codes |
websites:prepare |
websites.manage |
— |
websites_code_print |
Print a page code | GET /api/v1/websites/{id}/codes/{placement_id}/print |
websites:read |
websites.view |
— |
websites_publish_prepare |
Request approval to publish a website | POST /api/v1/approvals/websites-publish/{id} |
websites:execute |
websites.publish |
websites.publish |
websites_publish |
Publish website | POST /api/v1/approvals/{id}/websites-publish |
websites:execute |
websites.publish |
websites.publish |
websites_unpublish_prepare |
Request approval to withdraw a website | POST /api/v1/approvals/websites-unpublish/{id} |
websites:execute |
websites.publish |
websites.publish |
websites_unpublish |
Withdraw website | POST /api/v1/approvals/{id}/websites-unpublish |
websites:execute |
websites.publish |
websites.publish |
websites_restore_prepare |
Request approval to restore a website draft | POST /api/v1/approvals/websites-restore/{id} |
websites:execute |
websites.manage |
websites.edit |
websites_restore |
Restore to draft | POST /api/v1/approvals/{id}/websites-restore |
websites:execute |
websites.manage |
websites.edit |
websites_rollback_prepare |
Request approval to publish a saved website version | POST /api/v1/approvals/websites-rollback/{id} |
websites:execute |
websites.publish |
websites.publish |
websites_rollback |
Publish this version | POST /api/v1/approvals/{id}/websites-rollback |
websites:execute |
websites.publish |
websites.publish |
websites_access_grant_prepare |
Request approval to change who can edit a website | POST /api/v1/approvals/websites-access-grant/{id} |
websites:execute |
Workspace only | websites.grant |
websites_access_grant |
Change who can edit a website | POST /api/v1/approvals/{id}/websites-access-grant |
websites:execute |
Workspace only | websites.grant |
websites_access_set_prepare |
Request approval to change a person's website access | POST /api/v1/approvals/websites-access-set/{id} |
websites:execute |
websites.manage |
— |
websites_access_set |
Change a person's website access | POST /api/v1/approvals/{id}/websites-access-set |
websites:execute |
websites.manage |
— |
websites_code_close_prepare |
Request approval: Close a page code | POST /api/v1/approvals/websites-code-close/{id} |
websites:execute |
websites.manage |
— |
websites_code_close |
Close a page code | POST /api/v1/approvals/{id}/websites-code-close |
websites:execute |
websites.manage |
— |
Offers
| Tool | What it does | HTTP | Grant | Permission | Customer workspace |
|---|---|---|---|---|---|
offers_list |
List offer records | GET /api/v1/offers |
offers:read |
offers.manage |
— |
offers_counter_check |
Check a counter code | POST /api/v1/offers/counter/check |
offers:read |
offers.redeem |
counter.read |
offers_counter_recent |
Read recent counter activity | GET /api/v1/offers/counter/recent |
offers:read |
offers.redeem |
counter.read |
offers_claims_get |
Read an offer claim | GET /api/v1/offers/claims/{id} |
offers:read |
offers.manage |
widgets.read |
offers_cards_get |
Read a stamp card | GET /api/v1/offers/cards/{id} |
offers:read |
offers.manage |
widgets.read |
offers_events_get |
Read a counter event | GET /api/v1/offers/events/{id} |
offers:read |
offers.manage |
widgets.read |
offers_counter_confirm_prepare |
Request approval: Stamp or redeem at the counter | POST /api/v1/approvals/offers-counter-confirm |
offers:execute |
offers.redeem |
counter.read |
offers_counter_confirm |
Stamp or redeem at the counter | POST /api/v1/approvals/{id}/offers-counter-confirm |
offers:execute |
offers.redeem |
counter.read |
offers_counter_correct_prepare |
Request approval: Correct a counter visit | POST /api/v1/approvals/offers-counter-correct |
offers:execute |
offers.redeem |
counter.read |
offers_counter_correct |
Correct a counter visit | POST /api/v1/approvals/{id}/offers-counter-correct |
offers:execute |
offers.redeem |
counter.read |
Listings
| Tool | What it does | HTTP | Grant | Permission | Customer workspace |
|---|---|---|---|---|---|
listings_availability |
Set listing availability | POST /api/v1/listings/{id}/status |
listings:prepare |
listings.manage |
widget.listing_index or widget.listing |
listings_request_file |
Download a listing request file | GET /api/v1/listings/requests/{id}/files/{file_id} |
listings:read |
listings.manage |
contacts.read |
listings_get |
Read a listing | GET /api/v1/listings/{id} |
listings:read |
listings.manage or crm.use |
widget.listing_index or widget.listing |
listings_requests_get |
Read listing requests | GET /api/v1/listing-requests/{id} |
listings:read |
listings.manage or crm.use |
contacts.read |
listings_prepare |
Prepare a listing | POST /api/v1/listings/prepare |
listings:prepare |
listings.manage |
widget.listing_index or widget.listing |
listings_media_upload |
Upload a listing file | POST /api/v1/listings/media |
listings:prepare |
Workspace only | widget.listing_index or widget.listing |
views_listing |
View listings | GET /api/v1/views/listing |
listings:read |
listings.manage or crm.use |
widget.listing_index or widget.listing |
views_listing_request |
View listing requests | GET /api/v1/views/listing_request |
listings:read |
listings.manage or crm.use |
contacts.read |
listings_publish_prepare |
Request approval: Publish or withdraw a listing | POST /api/v1/approvals/listings-publish/{id} |
listings:execute |
listings.manage |
widget.listing_index or widget.listing |
listings_publish |
Publish or withdraw a listing | POST /api/v1/approvals/{id}/listings-publish |
listings:execute |
listings.manage |
widget.listing_index or widget.listing |
listings_follow_up_prepare |
Request approval: Follow up a listing enquiry | POST /api/v1/approvals/listings-follow-up/{id} |
listings:execute |
listings.manage |
contacts.read |
listings_follow_up |
Follow up a listing enquiry | POST /api/v1/approvals/{id}/listings-follow-up |
listings:execute |
listings.manage |
contacts.read |
listings_alert_privacy_lookup_prepare |
Request approval: Find a listing-alert subscriber | POST /api/v1/approvals/listings-alert-privacy-lookup |
listings:execute |
listings.manage |
privacy.manage |
listings_alert_privacy_lookup |
Find a listing-alert subscriber | POST /api/v1/approvals/{id}/listings-alert-privacy-lookup |
listings:execute |
listings.manage |
privacy.manage |
listings_alert_privacy_report_prepare |
Request approval: Report a listing-alert subscriber’s data | POST /api/v1/approvals/listings-alert-privacy-report |
listings:execute |
listings.manage |
privacy.manage |
listings_alert_privacy_report |
Report a listing-alert subscriber’s data | POST /api/v1/approvals/{id}/listings-alert-privacy-report |
listings:execute |
listings.manage |
privacy.manage |
listings_alert_privacy_erase_prepare |
Request approval: Erase a listing-alert subscriber’s data | POST /api/v1/approvals/listings-alert-privacy-erase |
listings:execute |
listings.manage |
privacy.manage |
listings_alert_privacy_erase |
Erase a listing-alert subscriber’s data | POST /api/v1/approvals/{id}/listings-alert-privacy-erase |
listings:execute |
listings.manage |
privacy.manage |
Bookings
| Tool | What it does | HTTP | Grant | Permission | Customer workspace |
|---|---|---|---|---|---|
booking-definitions_list |
List booking definitions | GET /api/v1/booking-definitions |
bookings:read |
bookings.manage |
— |
bookings_get |
Read a booking | GET /api/v1/bookings/{id} |
bookings:read |
bookings.manage or bookings.use |
contacts.read |
bookings_prepare |
Prepare a booking for human review | POST /api/v1/bookings/prepare |
bookings:prepare |
bookings.manage |
widget.booking_appointment or widget.booking_resource or widget.booking_capacity or widget.booking_event |
booking-definitions_save |
Save booking service | POST /api/v1/booking-definitions |
bookings:prepare |
bookings.manage |
widget.booking_appointment or widget.booking_resource or widget.booking_capacity or widget.booking_event |
booking-definitions_prepare |
Prepare a booking service for human review | POST /api/v1/booking-definitions/prepare |
bookings:prepare |
bookings.manage |
widget.booking_appointment or widget.booking_resource or widget.booking_capacity or widget.booking_event |
views_booking |
View bookings | GET /api/v1/views/booking |
bookings:read |
bookings.manage or bookings.use |
contacts.read |
bookings_settings |
Read booking settings | GET /api/v1/bookings/settings |
bookings:read |
bookings.manage |
widget.booking_appointment or widget.booking_resource or widget.booking_capacity or widget.booking_event |
bookings_schedule_save |
Save a booking schedule | POST /api/v1/bookings/schedules |
bookings:prepare |
bookings.manage |
widget.booking_appointment or widget.booking_resource or widget.booking_capacity or widget.booking_event |
bookings_block |
Block booking dates | POST /api/v1/bookings/blocks |
bookings:prepare |
bookings.manage |
widget.booking_appointment or widget.booking_resource or widget.booking_capacity or widget.booking_event |
bookings_unblock |
Open blocked dates | POST /api/v1/bookings/blocks/{id}/remove |
bookings:prepare |
bookings.manage |
widget.booking_appointment or widget.booking_resource or widget.booking_capacity or widget.booking_event |
bookings_feed_update |
Change a calendar feed | POST /api/v1/bookings/feeds/{id} |
bookings:prepare |
bookings.manage |
account.read |
bookings_feed_remove |
Remove a calendar feed | POST /api/v1/bookings/feeds/{id}/remove |
bookings:prepare |
bookings.manage |
account.read |
bookings_feed_refresh |
Check a calendar feed again | POST /api/v1/bookings/feeds/{id}/refresh |
bookings:prepare |
bookings.manage |
account.read |
bookings_change_quote |
Price a booking change | GET /api/v1/bookings/{id}/quote |
bookings:read |
bookings.manage or bookings.use |
contacts.read |
bookings_invoice_draft |
Draft an invoice for a booking | POST /api/v1/bookings/{id}/invoice |
bookings:prepare |
bookings.manage or bookings.use |
contacts.read |
bookings_file |
Download a booking file | GET /api/v1/bookings/{id}/files/{file_id} |
bookings:read |
bookings.manage or bookings.use |
contacts.read |
bookings_change_prepare |
Request approval: Change a booking | POST /api/v1/approvals/bookings-change/{id} |
bookings:execute |
bookings.manage |
contacts.read |
bookings_change |
Change a booking | POST /api/v1/approvals/{id}/bookings-change |
bookings:execute |
bookings.manage |
contacts.read |
bookings_mail_retry_prepare |
Request approval: Send a booking email again | POST /api/v1/approvals/bookings-mail-retry |
bookings:execute |
bookings.manage |
contacts.read |
bookings_mail_retry |
Send a booking email again | POST /api/v1/approvals/{id}/bookings-mail-retry |
bookings:execute |
bookings.manage |
contacts.read |
Content
| Tool | What it does | HTTP | Grant | Permission | Customer workspace |
|---|---|---|---|---|---|
content_report |
Read content records | GET /api/v1/content/{id}/report |
content:read |
content.manage |
widget.case_study or widget.guide or widget.menu |
content_request_prepare |
Prepare a recipient request | POST /api/v1/content-requests/prepare |
content:prepare |
content.manage |
widget.case_study or widget.guide |
content_media_upload |
Upload content media | POST /api/v1/content-media |
content:prepare |
Workspace only | widget.case_study or widget.guide or widget.menu |
content_request_revoke |
Revoke a content request | POST /api/v1/widgets/{id}/content-requests/{invitation_id}/revoke |
content:prepare |
content.manage |
widget.case_study or widget.guide |
content_media |
Download content media | GET /api/v1/content-media/{file_id}/{version_id} |
content:read |
content.manage |
widget.guide |
content_request_send_prepare |
Request approval: Send a content request | POST /api/v1/approvals/content-request-send/{id} |
content:execute |
content.manage |
widget.case_study or widget.guide |
content_request_send |
Send a content request | POST /api/v1/approvals/{id}/content-request-send |
content:execute |
content.manage |
widget.case_study or widget.guide |
content_subscriber_privacy_lookup_prepare |
Request approval: Find a content subscriber | POST /api/v1/approvals/content-subscriber-privacy-lookup |
content:execute |
content.manage |
privacy.manage |
content_subscriber_privacy_lookup |
Find a content subscriber | POST /api/v1/approvals/{id}/content-subscriber-privacy-lookup |
content:execute |
content.manage |
privacy.manage |
content_subscriber_privacy_report_prepare |
Request approval: Report a content subscriber’s data | POST /api/v1/approvals/content-subscriber-privacy-report |
content:execute |
content.manage |
privacy.manage |
content_subscriber_privacy_report |
Report a content subscriber’s data | POST /api/v1/approvals/{id}/content-subscriber-privacy-report |
content:execute |
content.manage |
privacy.manage |
content_subscriber_privacy_erase_prepare |
Request approval: Erase a content subscriber’s data | POST /api/v1/approvals/content-subscriber-privacy-erase |
content:execute |
content.manage |
privacy.manage |
content_subscriber_privacy_erase |
Erase a content subscriber’s data | POST /api/v1/approvals/{id}/content-subscriber-privacy-erase |
content:execute |
content.manage |
privacy.manage |
Analytics
| Tool | What it does | HTTP | Grant | Permission | Customer workspace |
|---|---|---|---|---|---|
analytics_read |
Read widget analytics | GET /api/v1/analytics |
analytics:read |
analytics.view |
analytics.read |
analytics_prepare |
Prepare analytics settings or a target | POST /api/v1/analytics/prepare |
analytics:prepare |
analytics.manage |
analytics.read |
analytics_records |
List analytics records | GET /api/v1/analytics/records |
analytics:read |
analytics.view |
analytics.read |
analytics_live |
Read live analytics | GET /api/v1/analytics/live |
analytics:read |
analytics.view |
analytics.read |
analytics_configuration |
Read analytics goals and views | GET /api/v1/analytics/configuration |
analytics:read |
analytics.view |
analytics.read |
analytics_settings |
Read analytics settings | GET /api/v1/analytics/settings |
analytics:read |
analytics.manage |
analytics.read |
analytics_goal_archive |
Archive an analytics goal | POST /api/v1/analytics/goals/{id}/archive |
analytics:prepare |
analytics.manage |
analytics.read |
analytics_target_delete |
Delete an analytics target | POST /api/v1/analytics/targets/{id}/delete |
analytics:prepare |
analytics.manage |
analytics.read |
analytics_view_save |
Save an analytics view | POST /api/v1/analytics/views |
analytics:prepare |
analytics.view |
analytics.read |
analytics_view_delete |
Delete an analytics view | POST /api/v1/analytics/views/{id}/delete |
analytics:prepare |
analytics.view |
analytics.read |
analytics_dismiss |
Hide or restore a next action | POST /api/v1/analytics/dismissals |
analytics:prepare |
analytics.view |
analytics.read |
analytics_website_prepare |
Request approval: Add an analytics website | POST /api/v1/approvals/analytics-website |
analytics:execute |
analytics.manage |
analytics.read |
analytics_website |
Add an analytics website | POST /api/v1/approvals/{id}/analytics-website |
analytics:execute |
analytics.manage |
analytics.read |
analytics_page_prepare |
Request approval: Approve an analytics page | POST /api/v1/approvals/analytics-page |
analytics:execute |
analytics.manage |
analytics.read |
analytics_page |
Approve an analytics page | POST /api/v1/approvals/{id}/analytics-page |
analytics:execute |
analytics.manage |
analytics.read |
analytics_campaign_prepare |
Request approval: Add an analytics campaign | POST /api/v1/approvals/analytics-campaign |
analytics:execute |
analytics.manage |
analytics.read |
analytics_campaign |
Add an analytics campaign | POST /api/v1/approvals/{id}/analytics-campaign |
analytics:execute |
analytics.manage |
analytics.read |
analytics_export_prepare |
Request approval: Export analytics | POST /api/v1/approvals/analytics-export |
analytics:execute |
analytics.view |
exports.read |
analytics_export |
Export analytics | POST /api/v1/approvals/{id}/analytics-export |
analytics:execute |
analytics.view |
exports.read |
Reports
| Tool | What it does | HTTP | Grant | Permission | Customer workspace |
|---|---|---|---|---|---|
reports_money |
Read the money overview | GET /api/v1/reports/money |
reports:read |
financial_summary.view |
— |
reports_aging |
Read the aging report | GET /api/v1/reports/aging |
reports:read |
data.export |
— |
reports_tax |
Read the tax report | GET /api/v1/reports/tax |
reports:read |
data.export |
— |
reports_customer_statement |
Read a customer statement | GET /api/v1/reports/customer-statement |
reports:read |
data.export |
— |
reports_overview |
Read the reports overview | GET /api/v1/reports/overview |
reports:read |
data.export |
— |
reports_business |
Read the business view | GET /api/v1/reports/business |
reports:read |
financial_summary.view |
— |
reports_tax_export_prepare |
Request approval: Export the tax report | POST /api/v1/approvals/reports-tax-export |
reports:execute |
data.export |
— |
reports_tax_export |
Export the tax report | POST /api/v1/approvals/{id}/reports-tax-export |
reports:execute |
data.export |
— |
reports_aging_export_prepare |
Request approval: Export the aging report | POST /api/v1/approvals/reports-aging-export |
reports:execute |
data.export |
— |
reports_aging_export |
Export the aging report | POST /api/v1/approvals/{id}/reports-aging-export |
reports:execute |
data.export |
— |
reports_statement_export_prepare |
Request approval: Export a customer statement | POST /api/v1/approvals/reports-statement-export |
reports:execute |
data.export |
— |
reports_statement_export |
Export a customer statement | POST /api/v1/approvals/{id}/reports-statement-export |
reports:execute |
data.export |
— |
reports_invoices_export_prepare |
Request approval: Export invoices | POST /api/v1/approvals/reports-invoices-export |
reports:execute |
data.export |
— |
reports_invoices_export |
Export invoices | POST /api/v1/approvals/{id}/reports-invoices-export |
reports:execute |
data.export |
— |
reports_money_export_prepare |
Request approval: Export the Money overview | POST /api/v1/approvals/reports-money-export |
reports:execute |
data.export |
— |
reports_money_export |
Export the Money overview | POST /api/v1/approvals/{id}/reports-money-export |
reports:execute |
data.export |
— |
Files
| Tool | What it does | HTTP | Grant | Permission | Customer workspace |
|---|---|---|---|---|---|
files_list |
List files and folders | GET /api/v1/files |
files:read |
files.view |
— |
files_get |
Read a file’s details | GET /api/v1/files/{id} |
files:read |
files.view |
— |
files_read_text |
Read a text file | GET /api/v1/files/{id}/text |
files:read |
files.view |
— |
files_prepare_text_version |
Prepare a new text version | POST /api/v1/files/{id}/text/prepare |
files:prepare |
files.manage |
— |
files_download |
Download a file | GET /api/v1/files/{id}/download |
files:read |
files.view |
— |
files_thumbnail |
Get a file preview image | GET /api/v1/files/{id}/thumbnail |
files:read |
files.view |
— |
files_share_preview |
Read a share link | GET /api/v1/files/shares/preview |
files:read |
files.view |
— |
files_proposal |
Read a text proposal | GET /api/v1/files/{id}/proposal |
files:read |
files.view |
— |
files_upload_prepare |
Start a file upload | POST /api/v1/files/uploads |
files:prepare |
files.manage |
— |
files_upload |
Create a file from an upload | POST /api/v1/files |
files:prepare |
files.manage |
— |
files_add_version |
Add a file version | POST /api/v1/files/{id}/versions |
files:prepare |
files.manage |
— |
files_rename |
Rename a file | POST /api/v1/files/{id}/name |
files:prepare |
files.manage |
— |
files_move |
Move a file | POST /api/v1/files/{id}/folder |
files:prepare |
files.manage |
— |
files_delete |
Delete a file | POST /api/v1/files/{id}/delete |
files:prepare |
files.manage |
— |
files_restore |
Restore a file | POST /api/v1/files/{id}/restore |
files:prepare |
files.manage |
— |
files_restore_version |
Restore a file version | POST /api/v1/files/{id}/versions/restore |
files:prepare |
files.manage |
— |
files_attach |
Attach a file to a record | POST /api/v1/files/{id}/attachments |
files:prepare |
files.manage |
— |
files_detach |
Remove a file from a record | POST /api/v1/files/{id}/attachments/remove |
files:prepare |
files.manage |
— |
files_selection |
Change several files at once | POST /api/v1/files/selection |
files:prepare |
files.manage |
— |
files_revoke_share |
Turn off a share link | POST /api/v1/files/{id}/shares/revoke |
files:prepare |
files.share |
— |
folders_create |
Create a folder | POST /api/v1/folders |
files:prepare |
files.manage |
— |
folders_rename |
Rename a folder | POST /api/v1/folders/{id}/name |
files:prepare |
files.manage |
— |
folders_move |
Move a folder | POST /api/v1/folders/{id}/parent |
files:prepare |
files.manage |
— |
folders_delete |
Delete a folder | POST /api/v1/folders/{id}/delete |
files:prepare |
files.manage |
— |
folders_restore |
Restore a folder | POST /api/v1/folders/{id}/restore |
files:prepare |
files.manage |
— |
files_share_prepare |
Request approval: Make a share link | POST /api/v1/approvals/files-share/{id} |
files:execute |
files.share |
— |
files_share |
Make a share link | POST /api/v1/approvals/{id}/files-share |
files:execute |
files.share |
— |
People
| Tool | What it does | HTTP | Grant | Permission | Customer workspace |
|---|---|---|---|---|---|
people_list |
List colleagues | GET /api/v1/people |
people:read |
people.view |
— |
people_get |
Read a colleague | GET /api/v1/people/{id} |
people:read |
people.view |
— |
teams_list |
List teams | GET /api/v1/teams |
people:read |
people.view |
— |
people_update |
Change a person’s details | POST /api/v1/people/{id} |
people:prepare |
people.view |
— |
people_photo_prepare |
Start a profile photo upload | POST /api/v1/people/photos |
people:prepare |
people.view |
— |
people_photo |
Set a profile photo | POST /api/v1/people/{id}/photo |
people:prepare |
people.view |
— |
people_photo_read |
Download a profile photo | GET /api/v1/people/{id}/photo |
people:read |
people.view |
— |
people_account |
Read a person’s account | GET /api/v1/people/{id}/account |
people:read |
people.manage |
— |
people_offboard_preview |
Preview an offboarding | GET /api/v1/people/{id}/offboard |
people:read |
people.manage |
— |
profile_get |
Read your profile | GET /api/v1/profile |
people:read |
Any connection | — |
profile_photo |
Set your profile photo | POST /api/v1/profile/photo |
people:prepare |
Any connection | — |
profile_update |
Change your display name | POST /api/v1/profile |
people:prepare |
Any connection | — |
desks_list |
Choose a desk | GET /api/v1/desks |
people:read |
people.view |
— |
desks_start_set |
Start in :desk next time | POST /api/v1/desks/start |
people:prepare |
people.view |
— |
people_invite_prepare |
Request approval: Invite a person | POST /api/v1/approvals/people-invite |
people:execute |
people.manage |
— |
people_invite |
Invite a person | POST /api/v1/approvals/{id}/people-invite |
people:execute |
people.manage |
— |
people_invitation_resend_prepare |
Request approval: Resend an invitation | POST /api/v1/approvals/people-invitation-resend/{id} |
people:execute |
people.manage |
— |
people_invitation_resend |
Resend an invitation | POST /api/v1/approvals/{id}/people-invitation-resend |
people:execute |
people.manage |
— |
people_invitation_revoke_prepare |
Request approval: Revoke an invitation | POST /api/v1/approvals/people-invitation-revoke/{id} |
people:execute |
people.manage |
— |
people_invitation_revoke |
Revoke an invitation | POST /api/v1/approvals/{id}/people-invitation-revoke |
people:execute |
people.manage |
— |
people_role_prepare |
Request approval: Change a person’s role | POST /api/v1/approvals/people-role/{id} |
people:execute |
people.manage |
— |
people_role |
Change a person’s role | POST /api/v1/approvals/{id}/people-role |
people:execute |
people.manage |
— |
people_guest_scope_prepare |
Request approval: Change a guest’s access | POST /api/v1/approvals/people-guest-scope/{id} |
people:execute |
people.manage |
— |
people_guest_scope |
Change a guest’s access | POST /api/v1/approvals/{id}/people-guest-scope |
people:execute |
people.manage |
— |
people_deactivate_prepare |
Request approval: Deactivate a person | POST /api/v1/approvals/people-deactivate/{id} |
people:execute |
people.manage |
— |
people_deactivate |
Deactivate a person | POST /api/v1/approvals/{id}/people-deactivate |
people:execute |
people.manage |
— |
people_reactivate_prepare |
Request approval: Reactivate a person | POST /api/v1/approvals/people-reactivate/{id} |
people:execute |
people.manage |
— |
people_reactivate |
Reactivate a person | POST /api/v1/approvals/{id}/people-reactivate |
people:execute |
people.manage |
— |
people_offboard_prepare |
Request approval: Offboard a person | POST /api/v1/approvals/people-offboard/{id} |
people:execute |
people.manage |
— |
people_offboard |
Offboard a person | POST /api/v1/approvals/{id}/people-offboard |
people:execute |
people.manage |
— |
people_delete_prepare |
Request approval: Delete a person | POST /api/v1/approvals/people-delete/{id} |
people:execute |
people.manage |
— |
people_delete |
Delete a person | POST /api/v1/approvals/{id}/people-delete |
people:execute |
people.manage |
— |
teams_save_prepare |
Request approval: Save a team | POST /api/v1/approvals/teams-save |
people:execute |
people.manage |
— |
teams_save |
Save a team | POST /api/v1/approvals/{id}/teams-save |
people:execute |
people.manage |
— |
teams_archive_prepare |
Request approval: Archive or restore a team | POST /api/v1/approvals/teams-archive/{id} |
people:execute |
people.manage |
— |
teams_archive |
Archive or restore a team | POST /api/v1/approvals/{id}/teams-archive |
people:execute |
people.manage |
— |
people_rate_prepare |
Request approval: Set a person’s rate | POST /api/v1/approvals/people-rate/{id} |
people:execute |
people.manage |
— |
people_rate |
Set a person’s rate | POST /api/v1/approvals/{id}/people-rate |
people:execute |
people.manage |
— |
people_time_off_prepare |
Request approval: Record time off | POST /api/v1/approvals/people-time-off/{id} |
people:execute |
people.manage |
— |
people_time_off |
Record time off | POST /api/v1/approvals/{id}/people-time-off |
people:execute |
people.manage |
— |
people_time_off_remove_prepare |
Request approval: Remove time off | POST /api/v1/approvals/people-time-off-remove/{id} |
people:execute |
people.manage |
— |
people_time_off_remove |
Remove time off | POST /api/v1/approvals/{id}/people-time-off-remove |
people:execute |
people.manage |
— |
people_desks_prepare |
Request approval: Assign a person’s desks | POST /api/v1/approvals/people-desks/{id} |
people:execute |
people.manage |
— |
people_desks |
Assign a person’s desks | POST /api/v1/approvals/{id}/people-desks |
people:execute |
people.manage |
— |
Collaboration
| Tool | What it does | HTTP | Grant | Permission | Customer workspace |
|---|---|---|---|---|---|
comments_list |
Read the comments of a record | GET /api/v1/comments |
collaboration:read |
collaboration.use |
— |
notifications_list |
Read the inbox | GET /api/v1/notifications |
collaboration:read |
collaboration.use |
— |
comments_create |
Write a comment | POST /api/v1/comments |
collaboration:prepare |
collaboration.use |
— |
comments_edit |
Edit a comment | POST /api/v1/comments/{id} |
collaboration:prepare |
collaboration.use |
— |
comments_remove |
Remove a comment | POST /api/v1/comments/{id}/remove |
collaboration:prepare |
collaboration.use |
— |
notifications_unread |
Count unread notifications | GET /api/v1/notifications/unread |
collaboration:read |
collaboration.use |
— |
notifications_mark |
Mark a notification read or unread | POST /api/v1/notifications/{id}/read |
collaboration:prepare |
collaboration.use |
— |
notifications_mark_all |
Mark all notifications read | POST /api/v1/notifications/read-all |
collaboration:prepare |
collaboration.use |
— |
notifications_preferences |
Read notification choices | GET /api/v1/notifications/preferences |
collaboration:read |
collaboration.use |
— |
notifications_preferences_set |
Change notification choices | POST /api/v1/notifications/preferences |
collaboration:prepare |
collaboration.use |
— |
activity_list |
Read record activity | GET /api/v1/activity |
collaboration:read |
collaboration.use |
— |
presence_settings |
Set online status choices | POST /api/v1/presence/settings |
collaboration:prepare |
collaboration.use |
— |
Forms
| Tool | What it does | HTTP | Grant | Permission | Customer workspace |
|---|---|---|---|---|---|
forms_get |
Read a form | GET /api/v1/forms/{id} |
forms:read |
forms.use |
— |
fields_schema |
Read custom field definitions | GET /api/v1/custom-fields |
forms:read |
forms.use |
— |
fields_get |
Read a record’s custom fields | GET /api/v1/custom-fields/{id} |
forms:read |
forms.use |
— |
fields_merge |
Fill merge fields | POST /api/v1/custom-fields/{id}/merge |
forms:read |
forms.use |
— |
forms_prepare |
Prepare form input | POST /api/v1/forms/prepare |
forms:prepare |
forms.use |
widget.form |
forms_submit |
Submit a form | POST /api/v1/forms/{id}/submit |
forms:prepare |
forms.use |
— |
fields_definitions |
List custom fields to edit | GET /api/v1/custom-fields/definitions |
forms:read |
forms.manage |
— |
fields_define |
Save a custom field | POST /api/v1/custom-fields/define |
forms:prepare |
forms.manage |
— |
fields_retire |
Retire a custom field | POST /api/v1/custom-fields/{id}/retire |
forms:prepare |
forms.manage |
— |
fields_set |
Set custom field values | POST /api/v1/custom-fields/{id}/values |
forms:prepare |
forms.use |
— |
widgets_preview |
Preview a widget definition | POST /api/v1/widgets/preview |
forms:read |
bookings.manage or content.manage or customers.manage or files.manage or forms.manage or items.manage or listings.manage or offers.manage or people.manage or people.view or projects.use or settings.manage |
widgets.manage |
widgets_preview_links |
Read widget links | GET /api/v1/widgets/{id}/links |
forms:read |
bookings.manage or content.manage or customers.manage or files.manage or forms.manage or items.manage or listings.manage or offers.manage or people.manage or people.view or projects.use or settings.manage |
widgets.read |
widgets_preview_read |
Read a widget preview | GET /api/v1/widgets/{id}/preview |
forms:read |
bookings.manage or content.manage or customers.manage or files.manage or forms.manage or items.manage or listings.manage or offers.manage or people.manage or people.view or projects.use or settings.manage |
widgets.read |
widgets_sample |
Read the widget sample page | GET /api/v1/widgets/sample |
forms:read |
forms.manage |
— |
widgets_placement_print |
Download a placement QR code | GET /api/v1/widgets/{id}/placements/{placement_id}/print |
forms:read |
bookings.manage or content.manage or customers.manage or files.manage or forms.manage or items.manage or listings.manage or offers.manage or people.manage or people.view or projects.use or settings.manage |
widgets.read |
widgets_response_file |
Download a response file | GET /api/v1/widgets/{id}/responses/{response_id}/files/{file_id} |
forms:read |
customers.manage or forms.manage |
widgets.read |
widgets_invitation_revoke |
Revoke a response request | POST /api/v1/widgets/{id}/invitations/{invitation_id}/revoke |
forms:prepare |
customers.manage or forms.manage |
widgets.manage |
widgets_save |
Save a widget definition | POST /api/v1/widgets |
forms:prepare |
bookings.manage or content.manage or customers.manage or files.manage or forms.manage or items.manage or listings.manage or offers.manage or people.manage or people.view or projects.use or settings.manage |
widgets.manage |
widgets_catalogue |
Read a shop catalogue | GET /api/v1/widgets/{id}/catalogue |
forms:read |
bookings.manage or content.manage or customers.manage or files.manage or forms.manage or items.manage or listings.manage or offers.manage or people.manage or people.view or projects.use or settings.manage |
— |
widgets_placements_save |
Save a widget placement | POST /api/v1/widget-placements |
forms:prepare |
bookings.manage or content.manage or customers.manage or files.manage or forms.manage or items.manage or listings.manage or offers.manage or people.manage or people.view or projects.use or settings.manage |
widgets.manage |
widgets_get |
Read a widget configuration | GET /api/v1/widgets/{id} |
forms:read |
bookings.manage or content.manage or customers.manage or files.manage or forms.manage or items.manage or listings.manage or offers.manage or people.manage or people.view or projects.use or settings.manage |
widgets.read |
widgets_prepare |
Prepare a widget configuration | POST /api/v1/widgets/prepare |
forms:prepare |
bookings.manage or content.manage or customers.manage or files.manage or forms.manage or items.manage or listings.manage or offers.manage or people.manage or people.view or projects.use or settings.manage |
widgets.manage |
widgets_placements_get |
Read a widget placement | GET /api/v1/widget-placements/{id} |
forms:read |
bookings.manage or content.manage or customers.manage or files.manage or forms.manage or items.manage or listings.manage or offers.manage or people.manage or people.view or projects.use or settings.manage |
widgets.read |
widgets_codes |
Read the QR codes | GET /api/v1/widget-codes |
forms:read |
bookings.manage or content.manage or customers.manage or files.manage or forms.manage or items.manage or listings.manage or offers.manage or people.manage or people.view or projects.use or settings.manage |
widgets.read |
widgets_placements_prepare |
Prepare a widget placement | POST /api/v1/widget-placements/prepare |
forms:prepare |
bookings.manage or content.manage or customers.manage or files.manage or forms.manage or items.manage or listings.manage or offers.manage or people.manage or people.view or projects.use or settings.manage |
widgets.manage |
widgets_requests_get |
Read an assigned widget request | GET /api/v1/widget-requests/{id} |
forms:read |
crm.use or crm.manage or people.view or items.manage or listings.manage or content.manage |
— |
widgets_library |
List this account's widgets | GET /api/v1/widget-library |
forms:read |
Workspace only | widgets.list |
widgets_image_upload |
Upload a widget photo | POST /api/v1/widget-images |
forms:prepare |
Workspace only | widgets.manage |
widgets_download_upload |
Upload a download file | POST /api/v1/widget-download-files |
forms:prepare |
Workspace only | widget.download |
widgets_visitor_settings_get |
Read the visitor door settings | GET /api/v1/widget-settings/visitor |
forms:read |
settings.manage |
— |
widgets_visitor_settings_save |
Save the visitor door settings | POST /api/v1/widget-settings/visitor |
forms:prepare |
settings.manage |
— |
widgets_visitor_endpoint_get |
Read the visitor door address | GET /api/v1/widget-settings/visitor-endpoint |
forms:read |
settings.manage |
— |
widgets_wallet_get |
Read the wallet setup | GET /api/v1/widget-settings/wallet |
forms:read |
settings.manage |
— |
widgets_placement_defaults_get |
Read the code style and map settings | GET /api/v1/widget-settings/codes |
forms:read |
settings.manage |
— |
widgets_placement_defaults_prepare |
Check the code style and map settings | POST /api/v1/widget-settings/codes/prepare |
forms:prepare |
settings.manage |
— |
widgets_placement_defaults_save |
Save the code style and map settings | POST /api/v1/widget-settings/codes |
forms:prepare |
settings.manage |
— |
widgets_placement_sets_list |
Read the placement sets | GET /api/v1/widget-placement-sets |
forms:read |
bookings.manage or content.manage or customers.manage or files.manage or forms.manage or items.manage or listings.manage or offers.manage or people.manage or people.view or projects.use or settings.manage |
widgets.read |
widgets_placement_sets_get |
Read a placement set | GET /api/v1/widget-placement-sets/{id} |
forms:read |
bookings.manage or content.manage or customers.manage or files.manage or forms.manage or items.manage or listings.manage or offers.manage or people.manage or people.view or projects.use or settings.manage |
widgets.read |
widgets_placement_sets_preview |
Preview a placement set | POST /api/v1/widget-placement-sets/preview |
forms:prepare |
bookings.manage or content.manage or customers.manage or files.manage or forms.manage or items.manage or listings.manage or offers.manage or people.manage or people.view or projects.use or settings.manage |
widgets.manage |
widgets_placement_sets_create |
Create a placement set | POST /api/v1/widget-placement-sets |
forms:prepare |
bookings.manage or content.manage or customers.manage or files.manage or forms.manage or items.manage or listings.manage or offers.manage or people.manage or people.view or projects.use or settings.manage |
widgets.manage |
widgets_placement_sets_organize |
Rename or file a placement set | POST /api/v1/widget-placement-sets/{id} |
forms:prepare |
bookings.manage or content.manage or customers.manage or files.manage or forms.manage or items.manage or listings.manage or offers.manage or people.manage or people.view or projects.use or settings.manage |
widgets.manage |
widgets_placement_sets_insights |
Read the figures of a placement set | GET /api/v1/widget-placement-sets/{id}/insights |
forms:read |
bookings.manage or content.manage or customers.manage or files.manage or forms.manage or items.manage or listings.manage or offers.manage or people.manage or people.view or projects.use or settings.manage |
widgets.read |
widgets_placement_sets_compare |
Compare placement sets | GET /api/v1/widget-placement-sets/compare |
forms:read |
bookings.manage or content.manage or customers.manage or files.manage or forms.manage or items.manage or listings.manage or offers.manage or people.manage or people.view or projects.use or settings.manage |
widgets.read |
widgets_placement_sets_downloads |
Read the downloads of a placement set | GET /api/v1/widget-placement-sets/{id}/downloads |
forms:read |
bookings.manage or content.manage or customers.manage or files.manage or forms.manage or items.manage or listings.manage or offers.manage or people.manage or people.view or projects.use or settings.manage |
widgets.read |
widgets_placement_sets_download |
Download a placement set | POST /api/v1/widget-placement-sets/{id}/download |
forms:read |
bookings.manage or content.manage or customers.manage or files.manage or forms.manage or items.manage or listings.manage or offers.manage or people.manage or people.view or projects.use or settings.manage |
widgets.read |
people_card_standard_get |
Read the card standard | GET /api/v1/card-standard |
forms:read |
people.view |
— |
people_card_standard_save |
Save the card standard | POST /api/v1/card-standard |
forms:prepare |
people.manage |
— |
people_card_signature_get |
Read a card email signature | GET /api/v1/card-signature/{id} |
forms:read |
people.view |
— |
widgets_launchers_list |
List widget launchers | GET /api/v1/widget-launchers |
forms:read |
forms.manage |
widgets.manage |
widgets_launchers_get |
Read a widget launcher | GET /api/v1/widget-launchers/{id} |
forms:read |
forms.manage |
widgets.manage |
widgets_launchers_options |
Read available launcher services | GET /api/v1/widget-launchers/options |
forms:read |
forms.manage |
widgets.manage |
widgets_launchers_save_prepare |
Request approval: Save a widget launcher | POST /api/v1/approvals/widgets-launchers-save |
forms:execute |
forms.manage |
widgets.manage |
widgets_launchers_save |
Save a widget launcher | POST /api/v1/approvals/{id}/widgets-launchers-save |
forms:execute |
forms.manage |
widgets.manage |
widgets_launchers_publish_prepare |
Request approval: Publish or close a widget launcher | POST /api/v1/approvals/widgets-launchers-publish/{id} |
forms:execute |
forms.manage |
widgets.manage |
widgets_launchers_publish |
Publish or close a widget launcher | POST /api/v1/approvals/{id}/widgets-launchers-publish |
forms:execute |
forms.manage |
widgets.manage |
widgets_launchers_delete_prepare |
Request approval: Remove a widget launcher | POST /api/v1/approvals/widgets-launchers-delete/{id} |
forms:execute |
forms.manage |
widgets.close |
widgets_launchers_delete |
Remove a widget launcher | POST /api/v1/approvals/{id}/widgets-launchers-delete |
forms:execute |
forms.manage |
widgets.close |
widgets_list |
List widgets | GET /api/v1/widgets |
forms:read |
forms.manage or people.view or people.manage or items.manage or offers.manage or listings.manage or settings.manage or customers.manage or files.manage or content.manage |
— |
widgets_requests_list |
List widget requests | GET /api/v1/widget-requests |
forms:read |
crm.use or crm.manage or people.view or items.manage or listings.manage or content.manage |
— |
locations_get |
Read business locations | GET /api/v1/locations |
forms:read |
settings.manage |
widget.locations |
locations_prepare |
Prepare a location | POST /api/v1/locations/prepare |
forms:prepare |
settings.manage |
widget.locations |
widgets_responses_get |
Read a customer answer | GET /api/v1/widget-responses/{id} |
forms:read |
customers.manage or forms.manage |
widgets.read |
widgets_responses_report |
Read response report | GET /api/v1/widgets/{id}/responses |
forms:read |
customers.manage or forms.manage |
widgets.read |
widgets_invitations_prepare |
Prepare a customer request | POST /api/v1/widget-invitations/prepare |
forms:prepare |
customers.manage or forms.manage |
widgets.manage |
views_widget_response |
View widget responses | GET /api/v1/views/widget_response |
forms:read |
forms.use |
— |
views_form |
View forms | GET /api/v1/views/form |
forms:read |
forms.use |
— |
views_form_record |
View form records | GET /api/v1/views/form_record |
forms:read |
forms.use |
— |
views_form_submission |
View form submissions | GET /api/v1/views/form_submission |
forms:read |
forms.use |
— |
views_form_submission_bulk |
Change many form submissions | POST /api/v1/views/form_submission/bulk |
forms:prepare |
forms.use |
— |
widgets_publish_prepare |
Request approval: Publish or withdraw a widget | POST /api/v1/approvals/widgets-publish/{id} |
forms:execute |
bookings.manage or content.manage or customers.manage or files.manage or forms.manage or items.manage or listings.manage or offers.manage or people.manage or people.view or projects.use or settings.manage |
widgets.manage |
widgets_publish |
Publish or withdraw a widget | POST /api/v1/approvals/{id}/widgets-publish |
forms:execute |
bookings.manage or content.manage or customers.manage or files.manage or forms.manage or items.manage or listings.manage or offers.manage or people.manage or people.view or projects.use or settings.manage |
widgets.manage |
widgets_placement_close_prepare |
Request approval: Close a placement | POST /api/v1/approvals/widgets-placement-close/{id} |
forms:execute |
bookings.manage or content.manage or customers.manage or files.manage or forms.manage or items.manage or listings.manage or offers.manage or people.manage or people.view or projects.use or settings.manage |
widgets.close |
widgets_placement_close |
Close a placement | POST /api/v1/approvals/{id}/widgets-placement-close |
forms:execute |
bookings.manage or content.manage or customers.manage or files.manage or forms.manage or items.manage or listings.manage or offers.manage or people.manage or people.view or projects.use or settings.manage |
widgets.close |
widgets_visitor_settings_widen_prepare |
Request approval: Open the visitor door to visitors' agents | POST /api/v1/approvals/widgets-visitor-settings-widen |
forms:execute |
settings.manage |
— |
widgets_visitor_settings_widen |
Open the visitor door to visitors' agents | POST /api/v1/approvals/{id}/widgets-visitor-settings-widen |
forms:execute |
settings.manage |
— |
widgets_placement_set_undo_prepare |
Request approval: Undo a placement set | POST /api/v1/approvals/widgets-placement-set-undo/{id} |
forms:execute |
bookings.manage or content.manage or customers.manage or files.manage or forms.manage or items.manage or listings.manage or offers.manage or people.manage or people.view or projects.use or settings.manage |
widgets.manage |
widgets_placement_set_undo |
Undo a placement set | POST /api/v1/approvals/{id}/widgets-placement-set-undo |
forms:execute |
bookings.manage or content.manage or customers.manage or files.manage or forms.manage or items.manage or listings.manage or offers.manage or people.manage or people.view or projects.use or settings.manage |
widgets.manage |
people_card_invite_prepare |
Request approval: Invite a person to publish a business card | POST /api/v1/approvals/people-card-invite/{id} |
forms:execute |
people.manage |
— |
people_card_invite |
Invite a person to publish a business card | POST /api/v1/approvals/{id}/people-card-invite |
forms:execute |
people.manage |
— |
widgets_wallet_change_prepare |
Request approval: Switch or remove a wallet platform | POST /api/v1/approvals/widgets-wallet-change |
forms:execute |
settings.manage |
— |
widgets_wallet_change |
Switch or remove a wallet platform | POST /api/v1/approvals/{id}/widgets-wallet-change |
forms:execute |
settings.manage |
— |
forms_publish_prepare |
Request approval: Publish or withdraw a form | POST /api/v1/approvals/forms-publish/{id} |
forms:execute |
forms.manage |
— |
forms_publish |
Publish or withdraw a form | POST /api/v1/approvals/{id}/forms-publish |
forms:execute |
forms.manage |
— |
widgets_request_send_prepare |
Request approval: Send a response request | POST /api/v1/approvals/widgets-request-send/{id} |
forms:execute |
forms.manage |
widgets.manage |
widgets_request_send |
Send a response request | POST /api/v1/approvals/{id}/widgets-request-send |
forms:execute |
forms.manage |
widgets.manage |
widgets_testimonial_moderate_prepare |
Request approval: Show or hide a testimonial | POST /api/v1/approvals/widgets-testimonial-moderate/{id} |
forms:execute |
forms.manage |
widgets.manage |
widgets_testimonial_moderate |
Show or hide a testimonial | POST /api/v1/approvals/{id}/widgets-testimonial-moderate |
forms:execute |
forms.manage |
widgets.manage |
forms_submissions_export_prepare |
Request approval: Export form submissions | POST /api/v1/approvals/forms-submissions-export |
forms:execute |
forms.manage |
— |
forms_submissions_export |
Export form submissions | POST /api/v1/approvals/{id}/forms-submissions-export |
forms:execute |
forms.manage |
— |
Settings
| Tool | What it does | HTTP | Grant | Permission | Customer workspace |
|---|---|---|---|---|---|
desks_settings |
Desks | GET /api/v1/desks/settings |
settings:read |
settings.manage |
— |
context_get |
Read your context | GET /api/v1/context |
settings:read |
Any connection | — |
records_search |
Search records | GET /api/v1/records/search |
settings:read |
Any connection | — |
tags_list |
List tags | GET /api/v1/tags |
settings:read |
Any connection | — |
settings_read |
Read company settings | GET /api/v1/settings/safe |
settings:read |
settings.manage |
— |
audit_retention |
Read the audit retention | GET /api/v1/audit/retention |
settings:read |
audit_log.view |
— |
audit_verify |
Verify the audit chain | GET /api/v1/audit/verify |
settings:read |
audit_log.view |
— |
installation_health_refresh |
Check installation health again | GET /api/v1/installation/health/refresh |
settings:read |
settings.manage |
— |
installation_update |
Read the update status | GET /api/v1/installation/update |
settings:read |
settings.manage |
— |
backups_list |
List backups | GET /api/v1/backups |
settings:read |
settings.manage |
— |
modules_list |
List modules | GET /api/v1/modules |
settings:read |
settings.manage |
— |
settings_email_templates |
Read email templates | GET /api/v1/settings/email-templates |
settings:read |
settings.manage |
— |
settings_bank_accounts |
Read bank accounts | GET /api/v1/settings/bank-accounts |
settings:read |
settings.manage |
— |
settings_roles |
Read roles | GET /api/v1/settings/roles |
settings:read |
users.manage |
— |
settings_intelligence |
Read intelligence settings | GET /api/v1/settings/intelligence |
settings:read |
settings.manage |
— |
workspaces_plans |
List workspace plans | GET /api/v1/workspaces/plans |
settings:read |
settings.manage |
— |
workspaces_plan |
Read a workspace plan | GET /api/v1/workspaces/plans/{id} |
settings:read |
settings.manage |
— |
workspaces_plan_choices |
Find workspace plans | GET /api/v1/workspaces/plan-choices |
settings:read |
settings.manage |
— |
records_recent |
Read recent records | GET /api/v1/records/recent |
settings:read |
Any connection | — |
records_tab_counts |
Count records per tab | GET /api/v1/records/tab-counts |
settings:read |
Any connection | — |
pins_list |
List pinned records | GET /api/v1/pins |
settings:read |
Any connection | — |
pins_toggle |
Pin or unpin a record | POST /api/v1/pins |
settings:prepare |
Any connection | — |
pins_remove |
Remove a pin | POST /api/v1/pins/{id}/remove |
settings:prepare |
Any connection | — |
views_saved_list |
List saved views | GET /api/v1/views/saved |
settings:read |
Any connection | — |
views_saved_save |
Save a view | POST /api/v1/views/saved |
settings:prepare |
Any connection | — |
views_saved_update |
Change a saved view | POST /api/v1/views/saved/{id} |
settings:prepare |
Any connection | — |
views_saved_delete |
Delete a saved view | POST /api/v1/views/saved/{id}/delete |
settings:prepare |
Any connection | — |
settings_assistant |
Assistant | GET /api/v1/settings/assistant |
settings:read |
settings.manage |
— |
assistant_save_prepare |
Confirm | POST /api/v1/approvals/assistant-save |
settings:execute |
settings.manage |
— |
assistant_save |
Save changes | POST /api/v1/approvals/{id}/assistant-save |
settings:execute |
settings.manage |
— |
settings_tax_catalog |
Tax setup | GET /api/v1/settings/tax-catalog |
settings:read |
settings.manage |
— |
audit_list |
List audit events | GET /api/v1/audit/events |
settings:read |
audit_log.view or audit_log.view_own |
— |
audit_get |
Read an audit event | GET /api/v1/audit/events/{id} |
settings:read |
audit_log.view or audit_log.view_own |
— |
audit_integrity |
Check audit history integrity | GET /api/v1/audit/integrity |
settings:read |
audit_log.view |
— |
installation_health |
Read installation health | GET /api/v1/installation/health |
settings:read |
settings.manage |
— |
settings_suppressions |
Blocked addresses (suppression ledger) | GET /api/v1/settings/email-suppressions |
settings:read |
settings.manage |
— |
settings_suppression_get |
One blocked address | GET /api/v1/settings/email-suppressions/{id} |
settings:read |
settings.manage |
— |
settings_save_prepare |
Request approval: Change settings | POST /api/v1/approvals/settings-save |
settings:execute |
settings.manage |
— |
settings_save |
Change settings | POST /api/v1/approvals/{id}/settings-save |
settings:execute |
settings.manage |
— |
settings_reset_prepare |
Request approval: Reset a settings section | POST /api/v1/approvals/settings-reset |
settings:execute |
settings.manage |
— |
settings_reset |
Reset a settings section | POST /api/v1/approvals/{id}/settings-reset |
settings:execute |
settings.manage |
— |
settings_number_sequence_prepare |
Request approval: Change a number sequence | POST /api/v1/approvals/settings-number-sequence/{id} |
settings:execute |
settings.manage |
— |
settings_number_sequence |
Change a number sequence | POST /api/v1/approvals/{id}/settings-number-sequence |
settings:execute |
settings.manage |
— |
settings_role_save_prepare |
Request approval: Save a role | POST /api/v1/approvals/settings-role-save |
settings:execute |
users.manage |
— |
settings_role_save |
Save a role | POST /api/v1/approvals/{id}/settings-role-save |
settings:execute |
users.manage |
— |
settings_role_delete_prepare |
Request approval: Delete a role | POST /api/v1/approvals/settings-role-delete/{id} |
settings:execute |
users.manage |
— |
settings_role_delete |
Delete a role | POST /api/v1/approvals/{id}/settings-role-delete |
settings:execute |
users.manage |
— |
settings_tax_create_prepare |
Request approval: Add a tax rate | POST /api/v1/approvals/settings-tax-create |
settings:execute |
settings.manage |
— |
settings_tax_create |
Add a tax rate | POST /api/v1/approvals/{id}/settings-tax-create |
settings:execute |
settings.manage |
— |
settings_tax_update_prepare |
Request approval: Change a tax rate | POST /api/v1/approvals/settings-tax-update/{id} |
settings:execute |
settings.manage |
— |
settings_tax_update |
Change a tax rate | POST /api/v1/approvals/{id}/settings-tax-update |
settings:execute |
settings.manage |
— |
settings_tax_reorder_prepare |
Request approval: Move a tax rate | POST /api/v1/approvals/settings-tax-reorder/{id} |
settings:execute |
settings.manage |
— |
settings_tax_reorder |
Move a tax rate | POST /api/v1/approvals/{id}/settings-tax-reorder |
settings:execute |
settings.manage |
— |
settings_tax_delete_prepare |
Request approval: Remove tax rate | POST /api/v1/approvals/settings-tax-delete/{id} |
settings:execute |
settings.manage |
— |
settings_tax_delete |
Remove tax rate | POST /api/v1/approvals/{id}/settings-tax-delete |
settings:execute |
settings.manage |
— |
settings_item_category_create_prepare |
Request approval: Add an item category | POST /api/v1/approvals/settings-item-category-create |
settings:execute |
settings.manage |
— |
settings_item_category_create |
Add an item category | POST /api/v1/approvals/{id}/settings-item-category-create |
settings:execute |
settings.manage |
— |
settings_item_category_update_prepare |
Request approval: Change an item category | POST /api/v1/approvals/settings-item-category-update/{id} |
settings:execute |
settings.manage |
— |
settings_item_category_update |
Change an item category | POST /api/v1/approvals/{id}/settings-item-category-update |
settings:execute |
settings.manage |
— |
settings_email_template_prepare |
Request approval: Change an email template | POST /api/v1/approvals/settings-email-template/{id} |
settings:execute |
settings.manage |
— |
settings_email_template |
Change an email template | POST /api/v1/approvals/{id}/settings-email-template |
settings:execute |
settings.manage |
— |
settings_email_template_reset_prepare |
Request approval: Reset an email template | POST /api/v1/approvals/settings-email-template-reset/{id} |
settings:execute |
settings.manage |
— |
settings_email_template_reset |
Reset an email template | POST /api/v1/approvals/{id}/settings-email-template-reset |
settings:execute |
settings.manage |
— |
settings_suppression_lift_prepare |
Request approval: Lift a blocked address | POST /api/v1/approvals/settings-suppression-lift/{id} |
settings:execute |
settings.manage |
— |
settings_suppression_lift |
Lift a blocked address | POST /api/v1/approvals/{id}/settings-suppression-lift |
settings:execute |
settings.manage |
— |
settings_bank_create_prepare |
Request approval: Add a bank account | POST /api/v1/approvals/settings-bank-create |
settings:execute |
settings.manage |
— |
settings_bank_create |
Add a bank account | POST /api/v1/approvals/{id}/settings-bank-create |
settings:execute |
settings.manage |
— |
settings_bank_update_prepare |
Request approval: Change a bank account | POST /api/v1/approvals/settings-bank-update/{id} |
settings:execute |
settings.manage |
— |
settings_bank_update |
Change a bank account | POST /api/v1/approvals/{id}/settings-bank-update |
settings:execute |
settings.manage |
— |
backups_create_prepare |
Request approval: Make a backup | POST /api/v1/approvals/backups-create |
settings:execute |
settings.manage |
— |
backups_create |
Make a backup | POST /api/v1/approvals/{id}/backups-create |
settings:execute |
settings.manage |
— |
backups_delete_prepare |
Request approval: Delete a backup | POST /api/v1/approvals/backups-delete |
settings:execute |
settings.manage |
— |
backups_delete |
Delete a backup | POST /api/v1/approvals/{id}/backups-delete |
settings:execute |
settings.manage |
— |
backups_schedule_prepare |
Request approval: Set the backup schedule | POST /api/v1/approvals/backups-schedule |
settings:execute |
settings.manage |
— |
backups_schedule |
Set the backup schedule | POST /api/v1/approvals/{id}/backups-schedule |
settings:execute |
settings.manage |
— |
intelligence_save_prepare |
Request approval: Change the AI suggestion settings | POST /api/v1/approvals/intelligence-save |
settings:execute |
settings.manage |
— |
intelligence_save |
Change the AI suggestion settings | POST /api/v1/approvals/{id}/intelligence-save |
settings:execute |
settings.manage |
— |
intelligence_test_prepare |
Request approval: Test the AI provider connection | POST /api/v1/approvals/intelligence-test |
settings:execute |
settings.manage |
— |
intelligence_test |
Test the AI provider connection | POST /api/v1/approvals/{id}/intelligence-test |
settings:execute |
settings.manage |
— |
workspaces_plan_save_prepare |
Request approval: Save a workspace plan | POST /api/v1/approvals/workspaces-plan-save |
settings:execute |
settings.manage |
— |
workspaces_plan_save |
Save a workspace plan | POST /api/v1/approvals/{id}/workspaces-plan-save |
settings:execute |
settings.manage |
— |
audit_export_prepare |
Request approval: Export the audit trail | POST /api/v1/approvals/audit-export |
settings:execute |
settings.manage |
— |
audit_export |
Export the audit trail | POST /api/v1/approvals/{id}/audit-export |
settings:execute |
settings.manage |
— |
audit_retention_save_prepare |
Request approval: Change the audit retention | POST /api/v1/approvals/audit-retention-save |
settings:execute |
settings.manage |
— |
audit_retention_save |
Change the audit retention | POST /api/v1/approvals/{id}/audit-retention-save |
settings:execute |
settings.manage |
— |
audit_prune_prepare |
Request approval: Remove expired audit events | POST /api/v1/approvals/audit-prune |
settings:execute |
settings.manage |
— |
audit_prune |
Remove expired audit events | POST /api/v1/approvals/{id}/audit-prune |
settings:execute |
settings.manage |
— |
audit_subject_report_prepare |
Request approval: Make a personal-data report | POST /api/v1/approvals/audit-subject-report |
settings:execute |
settings.manage |
— |
audit_subject_report |
Make a personal-data report | POST /api/v1/approvals/{id}/audit-subject-report |
settings:execute |
settings.manage |
— |
audit_subject_erase_prepare |
Request approval: Erase personal data | POST /api/v1/approvals/audit-subject-erase |
settings:execute |
settings.manage |
— |
audit_subject_erase |
Erase personal data | POST /api/v1/approvals/{id}/audit-subject-erase |
settings:execute |
settings.manage |
— |
settings_tax_class_create_prepare |
Request approval: Add tax class | POST /api/v1/approvals/settings-tax-class-create |
settings:execute |
settings.manage |
— |
settings_tax_class_create |
Add tax class | POST /api/v1/approvals/{id}/settings-tax-class-create |
settings:execute |
settings.manage |
— |
settings_tax_class_update_prepare |
Request approval: Edit tax class | POST /api/v1/approvals/settings-tax-class-update/{id} |
settings:execute |
settings.manage |
— |
settings_tax_class_update |
Edit tax class | POST /api/v1/approvals/{id}/settings-tax-class-update |
settings:execute |
settings.manage |
— |
settings_tax_class_retire_prepare |
Request approval: Retire tax class | POST /api/v1/approvals/settings-tax-class-retire/{id} |
settings:execute |
settings.manage |
— |
settings_tax_class_retire |
Retire tax class | POST /api/v1/approvals/{id}/settings-tax-class-retire |
settings:execute |
settings.manage |
— |
settings_tax_rule_create_prepare |
Request approval: Add tax rule | POST /api/v1/approvals/settings-tax-rule-create |
settings:execute |
settings.manage |
— |
settings_tax_rule_create |
Add tax rule | POST /api/v1/approvals/{id}/settings-tax-rule-create |
settings:execute |
settings.manage |
— |
settings_tax_rule_update_prepare |
Request approval: Edit tax rule | POST /api/v1/approvals/settings-tax-rule-update/{id} |
settings:execute |
settings.manage |
— |
settings_tax_rule_update |
Edit tax rule | POST /api/v1/approvals/{id}/settings-tax-rule-update |
settings:execute |
settings.manage |
— |
settings_tax_rule_retire_prepare |
Request approval: Retire tax rule | POST /api/v1/approvals/settings-tax-rule-retire/{id} |
settings:execute |
settings.manage |
— |
settings_tax_rule_retire |
Retire tax rule | POST /api/v1/approvals/{id}/settings-tax-rule-retire |
settings:execute |
settings.manage |
— |
desks_update_prepare |
Request approval: Arrange a desk | POST /api/v1/approvals/desks-update/{id} |
settings:execute |
settings.manage |
— |
desks_update |
Arrange a desk | POST /api/v1/approvals/{id}/desks-update |
settings:execute |
settings.manage |
— |
Need help with the product?
Contact support