MCP Connector · v3

Base v3 for your AI

Connect Base's v3 apps - BPM, Cowork, Project, Field, Prospectors, Lead, Sales, Dataset, Success, Workflow, Commerce, Inventory and Form - to your AI. Add the platform connector for a whole set of apps at once, or a single app - pick below. One Base sign-in covers them all.

https://aiconnector.base.vn/v3/mcp

Works in Claude, ChatGPT and any AI that supports remote MCP connectors: add a custom connector, paste an app's URL, sign in with Base.

1 · Add it to your AI

Pick your assistant - the steps differ slightly, the URL is the same either way. One Base sign-in covers every v3 app.

  1. In Claude, open Settings → Connectors.
  2. Click Add custom connector.
  3. Paste your Base MCP URL - pick one in Get your MCP URL below - and continue.
  4. You'll be sent to the Base sign-in screen - enter your Base email & password.
  5. Done. The Base tools now appear in your chats.

Using a different assistant? Anything that supports remote MCP connectors works the same way - paste the URL, sign in with Base.

2 · Get your MCP URL

Pick a single app or a platform bundle. Using several apps? Put them in one connector - a platform bundle or Everything - rather than adding each app on its own: one connector, one sign-in. What the connector covers and its tool list update with your choice.

More v3 apps appear here as they reach production - each at its own /v3/<app>/mcp.

Every v3 connector also carries rework_feedback_submit: tell your AI what's missing or confusing and it sends a feature request or issue straight to the Base team.

What you can do

BPM

Services & flows

List the services you can act on (with your create / manage rights) and read a flow's full graph - blocks & routing - in one call.

Run jobs

Start a job, watch its live per-stage state, update its fields, and advance the waiting stage - submit Manual forms, approve / reject Approvals, confirm or retry a paused AI step.

Collaborate

Post notes & threaded replies in a job's discussion; keep a checklist (todos with assignee + deadline) on any stage.

Author flows

One tool edits the whole flow: rename the service, add / edit / delete blocks, wire the routing, then validate the graph (one Start → … → End).

Cowork

Projects & boards

Organize work in workspaces & projects, pipelined through workspace stages. Add the right board for the job - Tasks (kanban), Flow (gated pipeline), Cost (budget), RIDAC (risks/issues/decisions), Docs & Files.

Tasks

Create, update, assign, move & complete tasks across lists and stages; read your own tasks across every project.

Planning

Milestones, WBS, outcomes, roadmap and a ranked backlog - plus budget lines and resource actuals.

Knowledge & governance

Write rich docs and keep a file registry; log issues and post project check-ins.

Project

Projects & boards

Run a service as a portfolio of projects - one per client or initiative. Give each project as many task boards as it needs plus an issue tracker, and read a whole project page in one call.

Tasks, stages & phases

Create & assign tasks, move them through your item stages, group them into time-boxed roadmap phases, and watch each phase roll up its own progress, workload & cost.

Plan the work

Shape the service once - item stages, project stages, item types & rates - then track milestones, outcomes, a ranked backlog and weekly check-ins.

Money in & out

Book workload (time), cost and income per project, so each one shows real revenue, cost & profit - not just effort - with reports & dashboards on top.

Field

Jobs & appointments

Run field-service jobs for your customers - each job breaks into appointments your crew executes: dispatch, assign, check in on site, check out when done, with no-show and reschedule handled cleanly - and crew members can propose a slot for a manager to approve.

Recurring visit plans

Put a rep on a route: one plan = staff + customer accounts + recurrence (say, every Tue & Thu). The plan computes the schedule of visits; checking in on an occurrence creates the visit - with per-account route notes.

Dispatch & shifts

See what needs action now - jobs with no appointments and unassigned slots - plan the week's board, and track work shifts (a check-in always happens on shift).

Customers & results

Customers come straight from your Sales app. Read visit history per account, customer feedback with ratings & tags, comments on any job or visit, and FSM / visit-coverage reports.

Custom fields

Decide what each service collects - on every visit for a visit-planning service, on every job for a field-service one. Add a field for one service or reuse a shared one, then fill values by name on visits, jobs and appointment work forms.

Prospectors

Your inbox

Read across every channel - WhatsApp, Telegram, Instagram and more - in one place: services, the channels connected to each, and the conversations flowing in with their sidebar counts.

Conversations & contacts

Open a conversation and page through its messages, pull the attached files & links, and look up the contact (profile) behind it with their labels & custom fields.

Team setup

See the labels, teams, message templates, canned responses, custom fields and broadcasts that shape how the inbox runs.

Automations

Build "flows" - a trigger (new conversation, keyword, button, ...) plus a node graph that can send, assign, branch, wait or hand off to an AI agent - then save, publish, pause or run them.

Lead

Funnels & leads

Run your lead funnels - capture a lead, fill its custom fields, then move it through the stages and statuses as it qualifies. Read a lead with its full history, activity and associations; list & count leads with filters. Keep its story in one place: add notes and log calls and meetings on the lead.

Marketing campaigns

Track campaigns end to end - ad, email or router - with spend, budget & UTM, brief, goals and team, plus per-campaign analytics so you see which campaign drove which leads.

Events, sources & contacts

Route incoming gateway events into the right funnel, connect sources & channels, and keep a clean contact profile per person - de-duplicated, with their timeline across every funnel.

Insights & audiences

Read cross-funnel insights - counts, trends and activity across services - and build an audience from your leads to push to an ad provider for retargeting or look-alikes.

Outreach sequences

Describe a follow-up plan and your AI builds the sequence: automatic emails and chats plus calls, LinkedIn touches and to-dos for your reps, each on its day. Write the emails in the same request - their templates are created for you. Chat steps are added as placeholders for you to finish in the app, then publish.

Sales

Pipelines & deals

Run your deal pipelines end to end - open a deal, fill its custom fields, move it between stages, then close it won or lost with a reason. See a pipeline as a board with per-stage totals, or page through the whole table with filters.

Companies & people

Keep your account and contact directories current - create and edit companies and the people at them, set owners and collaborators, and read any party with their whole deal history attached.

What you are selling

Build the commercial detail on a deal: product line items with price, quantity and discount, the extra people on the buying committee, and quotes, orders, contracts or subscriptions with their own status.

Forecast & hygiene

Commit deals to a monthly forecast against quotas and read the gap, aggregate any slice of the CRM into numbers, and find and merge duplicate deals, companies or people.

Dataset

Tables & columns

Build your own tables for anything you track and keep them in folders. Pick the columns from your shared field library - text, numbers, dates, pickers, people, links to other tables - and set each column's width, visibility and whether it's required.

Rows

Add, edit and reorder rows and fill every cell, share a row with teammates, and read its change history. Linked columns pull the related rows - and the values looked up or rolled up from them - straight in.

Bulk & find

Create or update up to 100 rows at once, duplicate rows, search across every table, folder and row, and filter, sort and page through large tables.

Views & summaries

Save views - a named filter, sort and layout - and pick the default. Group and summarize rows (count, sum, average, min, max) on tables with analytics turned on, without exporting anything.

Success

Write articles

Draft and edit Help Center articles - title, summary, body and tags - and keep them as drafts until they're ready. Headings, lists and images in the body show up in the Help Center as written. Retire old articles by archiving them.

Images

Upload an image from a file or a link and place it in an article, with its size, alignment and caption set right in the text.

Organize & publish

Sort articles into categories (they can nest), then publish them onto the collections of your public Help Center site - several articles at once.

Glossary

Keep a glossary of terms - each with its definition, alternative spellings and related terms - shown across your Help Center.

Workflow

Workflows & stages

Browse your workflows (pipeline templates) and the ordered stages a job passes through; stand up a new workflow or add stages.

Run jobs

Create a job and drive it through the pipeline - advance, send back, fail, reassign, move or archive - filling the stage form and custom fields as you go.

Stay on top of work

Your personal task inbox and a dashboard of active / overdue jobs and open todos; keep a checklist on any job.

Set the pipeline up

Recurring schedules that spawn jobs, labels & tags, end-reasons for when a job finishes or fails, and the compose form.

Commerce

Catalogs & categories

Browse your catalogs and the category tree inside each; add categories and labels to keep products organised.

Products & variants

Find a product by name, code or SKU; create and edit products with their own price - one-off or a monthly / yearly subscription - and add variants (size, colour, plan) each priced on its own.

Price books

See which price books you sell from, their currency and validity, and which ones apply to a given customer.

Prices & rules

Put products into a price book and set what they sell at; add volume tiers or discounts by quantity, and check the price for any quantity before you quote.

Inventory

Warehouses & bins

Set up warehouses and their storage locations - zones, racks, shelves and bins - in one go, and see what is stored where on the bin map.

Stock at a glance

On hand, reserved and available for every item - per bin and lot, and across all warehouses - with its cost and full movement history.

Goods in, goods out

Receive from a supplier, ship to a customer, transfer between warehouses and count stock: your AI creates the document with its lines and posts it, and stock updates the moment it is posted.

Reorder & value

Low-stock alerts and what to reorder, stock value by warehouse or product, and the cost of goods delivered.

Form

Build in one request

Describe the form and your AI creates it with every question - text, email, phone, numbers, dates, dropdowns, ratings - laid out in sections, side by side, and across pages.

Smart questions

Show a question only when an earlier answer matches, fill one from the link (campaign, source) or copy another answer, and set limits like min / max or a maximum length.

After submit

Rules on the answers decide who gets emailed, which webhook receives the response, and whether people see a thank-you message or go to a page of yours.

Publish & responses

Pick a theme, publish, and get the public link - pre-filled if you like. Then read the responses, mark spam or processed, and get a per-question summary.

Id types - don't mix them

  • service_id is a SUID string (e.g. aExd…) - from rework_bpm_service_list. Block ids (from rework_bpm_service_get with includeBlocks) are strings too.
  • job.id and job_block_id are integers - from rework_bpm_job_get (.blocks[].id = the job_block_id; status 20 = waiting on a human).

Lead - building a sequence

A sequence is a follow-up plan for your leads: a list of steps, each on a day. Day 1 is the day a lead joins, and the waits between days are added for you. Describe the plan in plain words and your AI builds it with every step in one go.

Try asking: "In my Inbound Leads funnel, build a two-week outreach sequence: on day 1 an intro email and a chat message, day 2 a LinkedIn connection request, day 3 a call, day 4 a follow-up email, day 6 a LinkedIn message, day 8 a case-study email, day 10 a task to review how engaged they are, and day 14 a break-up email that replies in the same thread. Write the emails for me."
StepHow it runsWhat your AI sets up
EmailAutomaticWrites the subject and body and saves them as an email template attached to the step - or reuses a template you already have. It can reply in the thread of the previous email.
ChatAutomaticAdds the step empty, for you to write the message in the app - it depends on the chat channel you connect.
CallTask for a repThe task title, a call script, a due date and priority.
LinkedIn - connect, message or view profileTask for a repThe note or message to send.
SMS, personal email, direct mailTask for a repThe message or what to send. A personal email goes out from the rep's own mailbox.
To-doTask for a repAny other follow-up, with a due date.

Rep tasks go to the lead's owner unless you name someone.

From draft to live

  1. Ask for the sequence. Your AI saves it as a draft with all its steps, attaches a rule set (sending limits, and what happens when a lead replies - one you already have, or a new one with sensible defaults), and tells you anything still missing before it can go live.
  2. Finish the chat steps in the Lead app, under Sequences.
  3. Publish - ask your AI, or publish it in the app.
  4. Add leads: select them in the Lead app and choose Enroll in sequence, or enroll them through an automation. Nothing is sent until leads are enrolled.
  • To change a sequence, describe the new plan - your AI reads the current one and rewrites the whole step list. Publish again to put the change live; leads already in the sequence carry on with the version they started on.
  • You need manage rights on the funnel to build or publish its sequences.

Commerce - a product's price vs. its price book

A product has its own price, but quotes, orders and subscriptions sell from a price book. A product can be sold once it is listed in a book, where it gets its own price in that book.

  • Listing copies the price once. Ask your AI to list a product in a book and it takes the product's own price. Changing the product's price later doesn't change the book - to change what something sells at, ask to update its price in that book.
  • One currency per book. A book prices in one currency unless it also allows others, and your AI won't put a price in a different currency into it.
  • One price per product per billing period. The same product can have a one-off price and a monthly or yearly one in the same book; to change a price, update the existing one.
  • Quantity pricing comes from price rules attached to a price: the unit price can drop at a quantity (tiers) or get a percentage off (volume discount).
  • Nothing is deleted. Retire a catalog, product, price book, price or rule instead - retired prices and rules stop applying.
  • Creating a catalog, a price book or a price rule is for Commerce admins; other changes need manage rights on the catalog or price book.
Try asking: "Add a yearly 'Support Plus' plan at $1,200 to our main catalog and list it in our standard price book."  ·  "What would 50 units of our Growth plan cost with the volume tiers?"

Inventory - how stock moves

Stock only changes through stock documents. Your AI creates the document with its lines, then posts it - the quantities change the moment it is posted.

DocumentWhat it doesWhen it is posted
Receipt (goods in)Adds stock from a supplier - to an item you already hold, or as a new item in a binEvery line is received - in full by default, at its purchase price. You can receive less, or nothing, on any line.
Delivery (goods out)Takes stock out for a customerThe stock is held first; if there isn't enough available, the delivery is refused (unless the warehouse allows negative stock).
TransferMoves stock to another warehouseTaken out at the source, then it arrives at the destination as an incoming receipt - receive it there. The goods keep their cost.
Stock count (adjustment)Corrects the quantity to what you countedGive the counted quantity; the difference is posted, with a reason such as Damaged or Periodic count.
  • Quantities are never edited directly - count or correct them with a stock count. A new item can start with an opening quantity.
  • Posted documents are final. Cancel a document before it is posted instead; nothing is ever deleted.
  • Products come from your Commerce catalog. An item that isn't in the catalog can still be stocked by name and SKU.
  • Low-stock alerts and reorder suggestions cover items linked to a catalog product that were delivered in the last 90 days.
  • Creating a warehouse is for Inventory admins; other changes need manage rights on the warehouse.
Try asking: "Receive 60 keyboards and 200 reams of A4 paper from our supplier into the Hanoi warehouse, bin B-01."  ·  "Move 5 laptops from Hanoi to Ho Chi Minh City."  ·  "We counted 75 mice, not 77 - fix it as damaged."

Form - from questions to responses

A form stays a private draft until you publish it. Once published, anyone with its link can fill it in - no sign-in needed.

  1. Describe the form. Your AI creates it with all its questions in one go - sections, side-by-side fields, pages, required answers, dropdown choices.
  2. Add logic if you need it. "Show Number of guests only when Attendance is In person." A hidden question can pick up a value from the link, such as ?utm_source=facebook.
  3. Decide what happens after submit. Rules are checked in order and the first match runs: email your team, send the response to a webhook, then show a thank-you message or send people to a page. With no rules, people see "Thank you - We have received your information."
  4. Style it and publish. Pick a theme (Clean, Lagoon, Forest, Honey, Sunset, Ember, Blossom, Orchid, Slate, Ink, Midnight, Carbon) and adjust colours, corners, font and width. Then publish and share the link.
  5. Work the responses. Read them, mark junk as spam and handled ones as processed, export them, and get a summary of the answers to each question.
  • Changes to a published form go live immediately. Unpublish it to stop new responses - the ones you have are kept.
  • Replacing the whole question list keeps what you resend: a question with the same name keeps its earlier answers. A question that another question's logic or the after-submit rules depend on can't be removed until those change.
  • Emails go to fixed addresses you name in the rule. Re-running the after-submit steps for a response sends its emails and webhooks again, so your AI asks first.
  • File uploads, tables and formulas aren't available on public forms. Nothing is deleted from here - unpublish a form instead.
  • Anyone can create a form; changing one needs its creator, an owner or a Form admin.
Try asking: "Make a registration form for our October meetup: name, email, phone side by side, company, in person or online, number of guests only for in person, and a feedback page with a rating. Email events@ourcompany.com for online sign-ups, then publish it and give me the link."  ·  "Summarise this week's responses to the meetup form."

The tools

BPM - rework_bpm_*

ToolAccessWhat it does
Discovery & identity
rework_bpm_mereadWho you are (id, name, email) - use the id to assign work to yourself
rework_bpm_service_listreadThe services (flows) you can act on, with your rights
rework_bpm_service_getreadOne service; includeBlocks=true also returns the full flow graph (blocks + routing)
Flow authoring
rework_bpm_flow_editwriteThe whole flow editor in one tool - update_service · add_block · edit_block · wire (connect edges) · delete_block · validate
Jobs
rework_bpm_job_createwriteStart a run (title; optional custom-field data, followers, tags)
rework_bpm_job_listreadJobs in a service (status filter, pagination)
rework_bpm_job_getreadOne job + live per-stage state - which block waits on a human
rework_bpm_job_updatewriteEdit a job: title, custom fields, deadline
rework_bpm_stage_tagswriteSet the tags on a job stage (a job's tags are the roll-up of its stages')
rework_bpm_fieldwriteThe data fields a service collects - see what your workspace already has, who uses it, attach an existing field, or add a new one
rework_bpm_job_advancewritePush the waiting stage - submit a Manual form, approve / reject an Approval, or confirm / retry a paused AI step
rework_bpm_job_cancelwriteCancel an active job (terminal; requires manage)
Collaboration
rework_bpm_discussion_createwritePost a note on a job, or reply (threaded) - HTML content
rework_bpm_todowriteThe checklist on a job stage - list it or add items (assignee, deadline)

Cowork - rework_cowork_*

ToolAccessWhat it does
rework_cowork_mereadWho you are (id, name, email)
rework_cowork_workspaceread writeWorkspaces + their operational stages - pipeline projects across a workspace
rework_cowork_project_list · rework_cowork_project_editread writeList / open projects; create, update, place & move them across workspace stages
rework_cowork_board_list · rework_cowork_board_editread writeOpen a board (model-aware); create boards + their columns (Tasks / Flow / Cost / RIDAC / Docs / Files)
rework_cowork_task_list · rework_cowork_task_editread writeList your / a board's tasks; create, update, set status & move them
rework_cowork_flowread writeFlow boards - gated steps + items advancing through the pipeline
rework_cowork_planread writeMilestones, WBS, outcomes, roadmap & backlog
rework_cowork_resourceread writeBudget - planned cost / effort lines + resource actuals
rework_cowork_issueread writeProject issue register + check-ins
rework_cowork_docread writeRich docs + a file registry on a board
rework_cowork_searchread writeSearch, dashboard & item types

Project - rework_pj_*

ToolAccessWhat it does
Reads
rework_pj_mereadWho you are (id, name, email)
rework_pj_pagereadOne-call page reads - your portfolio, a project's items, milestones, phases, costs / incomes / workloads, org chart
Projects & boards
rework_pj_projectread writeList / open projects; create, update, pin
rework_pj_boardread writeA project's boards - add as many task boards as you need, plus issue boards
rework_pj_groupread writeThe group bands that organize a board's items
Work items
rework_pj_itemread writeTasks - create, assign, schedule, place on a board / stage / phase, complete
rework_pj_issueread writeThe issue register - problems kept out of the task tree
rework_pj_item_typeread writeThe service's catalogs - work, issue, workload & income types (with rates)
rework_pj_stageread writeItem stages & project stages - the shared columns every project in a service moves through
rework_pj_phaseread writeRoadmap phases - time-boxed stages with per-phase progress, workload & cost rollups
Plan
rework_pj_milestoneread writeMilestones & outcomes
rework_pj_backlogread writeA ranked backlog - vote, reorder, convert ideas into tasks
rework_pj_checkinread writeProject status check-ins (on-track / at-risk + progress)
Knowledge
rework_pj_docread writeProject documents - a tree of rich pages & folders
Money & reporting
rework_pj_resourceread writeBookings - workload (time), cost & income lines that drive each project's P&L
rework_pj_outputread writeWork outputs + the done / failed reason lists
rework_pj_reportread writeReports, dashboards & saved board views
Admin
rework_pj_adminread writeServices, templates, org units & currencies

Field - rework_field_*

ToolAccessWhat it does
Reads
rework_field_mereadWho you are (id, name, email)
rework_field_pagereadOne-call page reads - my day across both models, a service's overview, a plan + its visits
rework_field_searchreadSearch jobs, appointments, visits & plans
Setup
rework_field_serviceread writeThe services - Visit Planning or Field Service - and the schedule board
rework_field_accountreadCustomers & contacts (live from Sales) + per-account visit history
rework_field_templateread writeField-service catalogs - job types, appointment types & skills
rework_field_customfieldread writeCustom fields - add them to a visit-planning or field-service service (for that service only, or shared), then fill them on visits, jobs & appointments
Visit planning
rework_field_planread writeRecurring plans - staff + accounts + recurrence, computed schedules, per-account route notes
rework_field_visitread writeVisits - plan ahead, check in on site, fill the visit form, check out
Field service
rework_field_jobread writeJobs - the customer contract; its status follows its appointments
rework_field_appointmentread writeAppointments - create, edit, fill the work form, my queue, propose a slot
rework_field_appointment_actionwriteThe crew lifecycle - dispatch, assign, check-in, check-out, no-show, reschedule, reopen + approve / decline proposals
rework_field_dispatchreadThe dispatcher board - what needs action now, the planned week, per-staff workload
Operations
rework_field_shiftread writeWork shifts - start / end my shift, who's on shift now, history
rework_field_commentread writeComment threads on a job, appointment or visit
rework_field_feedbackread writeCustomer feedback (ratings + tags) per job or service-wide
rework_field_reportread writeField-service & visit-coverage reports, dashboards

Prospectors - rework_prospector_*

ToolAccessWhat it does
Inbox
rework_prospector_mereadWho you are (id, name, email)
rework_prospector_servicereadInbox services - the top container
rework_prospector_channelreadThe connected provider channels (WhatsApp / Telegram / Instagram / ...)
rework_prospector_conversationreadConversation threads + sidebar counts + attached files & links
rework_prospector_messagereadMessages in a conversation, paged
rework_prospector_profilereadContacts (profiles) behind conversations, with labels & fields
Setup
rework_prospector_labelreadLabels
rework_prospector_template · rework_prospector_cannedreadMessage templates & canned responses
rework_prospector_fieldreadCustom field definitions
rework_prospector_broadcastreadBroadcast campaigns + their recipients
Automation
rework_prospector_flowread writeBuild & run "flows" from a plain-words request - a trigger + steps that reply, ask, branch, wait, route to a team, update fields or hand off to AI; test before you publish, then pause, run or check each run
rework_prospector_lookupreadThe real names and ids a flow needs - inboxes, channels, stages, AI agents, people, routers, booking forms

Lead - rework_ld_*

ToolAccessWhat it does
Reads
rework_ld_mereadWho you are (id, name, email)
rework_ld_service_getreadYour lead funnels (services) and a funnel's stages, labels & blacklist
rework_ld_lead_listreadList & count leads in a funnel, with filters
rework_ld_lead_getreadOne lead in full - its custom fields, activity, feed, ad attribution & associations
rework_ld_insightsreadCross-funnel insights - counts, trends, activity & search across services
Leads
rework_ld_lead_editwriteCapture & manage a lead - create, update, set a field, set owner, move stage / status, convert, blacklist, associate, bulk-edit, recalculate score
rework_ld_lead_notewriteWrite on a lead's activity stream - add a note, log a call or meeting that already happened, edit a note, pin an entry
Funnel setup
rework_ld_leadservice_editwriteCreate & configure a lead funnel (service)
rework_ld_field_editwriteThe custom fields a funnel collects
rework_ld_stage_editwriteThe stages a lead moves through
rework_ld_label_editwriteLabels used to tag leads
Marketing
rework_ld_campaign_getreadCampaigns + their analytics & spend
rework_ld_campaign_editwriteCreate & update campaigns - record spend, brief, goals, team, budget & UTM
rework_ld_event_getreadGateway events + stats & routing targets
rework_ld_event_editwriteRoute a gateway event into a lead funnel
rework_ld_audience_createwriteBuild an audience from your leads and push it to an ad provider
Contacts & sources
rework_ld_profile_getreadContact profiles (people) + their timeline & activity
rework_ld_profile_editwriteCreate & update a contact profile
rework_ld_source_getreadSources & channels, the integration catalog & stats
rework_ld_source_editwriteSet up sources and their channels
rework_ld_blacklist_editwriteBlacklist rules that keep unwanted leads out
rework_ld_salesmanread writeSalesmen - list, read, update & sync
Sequences
rework_ld_sequence_getreadYour sequences and what they're built from - email templates, rule sets, sender mailboxes, chat channels, and who's enrolled
rework_ld_sequence_editwriteBuild a sequence with all its steps in one go - automatic email & chat, plus call, LinkedIn, SMS, personal-email, direct-mail & to-do tasks - then publish it
rework_ld_sequence_templatewriteCreate & edit the email templates a sequence's emails use

Sales - rework_sl_*

ToolAccessWhat it does
Find your way around
rework_sl_mereadWho you are (id, name, email)
rework_sl_pipeline_getreadThe CRM home (totals + your pipelines), your own work, and one pipeline as an overview or a board
rework_sl_service_getreadPipelines, account & contact directories and forecast books - plus a container's stages, labels, segments, win / loss reasons and custom fields
rework_sl_searchreadOne search across deals, companies and people
Deals
rework_sl_deal_listreadFind deals - whole board, paged table with filters, by company or person, or just yours
rework_sl_deal_getreadOpen one deal, with its company, primary and secondary contacts, and its stage history
rework_sl_deal_editwriteCreate a deal, then set name / amount, owner, company, contact, labels, close date, win probability, collaborators, custom fields or files
rework_sl_deal_lifecyclewriteMove a deal between stages or pipelines, close it won or lost with a reason, reopen it, star or follow it
rework_sl_deal_bulkwriteApply one change to many deals at once - owner, labels, stage, custom fields, followers, mark lost or reopen
What is on the deal
rework_sl_deal_contactwriteThe extra people on a deal (the buying committee) and their role
rework_sl_deal_productwriteProduct line items - price, quantity, discount, tax
rework_sl_deal_commercewriteQuotes, orders, contracts and subscriptions, each with its own status
rework_sl_product_listreadThe product catalogue, to pick a line item from
Companies & people
rework_sl_account_listreadFind companies - quick list, paged table, or the ones you own
rework_sl_account_getreadOne company, its people and its deals
rework_sl_account_editwriteCreate & update companies - fields, owner, collaborators, stage, followers, and bulk edits
rework_sl_contact_listreadFind people - quick list, paged table, everyone at a company, or the ones you own
rework_sl_contact_getreadOne person and the deals they are on
rework_sl_contact_editwriteCreate & update people - email, phone, title, their company, owner, stage, and bulk edits
Forecasting & analysis
rework_sl_forecastread writeCommit deals to a monthly forecast, set quotas per person, and read the quota gap
rework_sl_reportreadAggregate any slice of the CRM into numbers, and read your saved dashboards
rework_sl_duplicateread writeFind likely duplicate deals, companies or people - and merge them
Setting up a pipeline
rework_sl_service_editwriteCreate or reconfigure a pipeline, directory or forecast book, and choose which custom fields it carries
rework_sl_stage_editwriteAdd, rename and reorder stages - and mark which ones count as won or lost
rework_sl_taxonomy_editwriteLabels, segments and win / loss reasons
rework_sl_field_editwriteDefine the custom fields your records carry
rework_sl_pipeline_adminwritePipeline rules (no skipping or moving backwards), currency & forecast options, required fields on close, and who can see or do what

Dataset - rework_ds_*

ToolAccessWhat it does
Find your way around
rework_ds_mereadWho you are (id, name, email)
rework_ds_dataset_getreadYour tables - list them, open one, read its full set of columns and how it links to other tables, or get a one-call overview
rework_ds_searchreadQuick search across tables, folders and rows
Tables & columns
rework_ds_dataset_editwriteCreate a table, rename or update it, copy its structure, share it with teammates, star it
rework_ds_schemawriteAdd or remove a column, set its width, visibility, required flag and description, and reorder columns
rework_ds_fieldread writeThe shared field library your columns come from - browse it; admins can add or edit fields
Rows
rework_ds_record_getreadRead rows - page, search, filter and sort a table, open one row in full (linked values included), or read its change history
rework_ds_record_editwriteAdd a row and fill its cells, edit it, move it, or share it with teammates
rework_ds_record_bulkwriteCreate, update, upsert or duplicate many rows at once (up to 100)
rework_ds_record_aggreadGroup rows and count, sum or average them without fetching every row
Views & folders
rework_ds_viewread writeSaved views - a named filter, sort and layout - including which one is the default
rework_ds_folderread writeFolders that organize your tables

Success - rework_success_*

ToolAccessWhat it does
Find your way around
rework_success_mereadWho you are (id, name, email)
rework_success_servicereadYour Help Center spaces - where articles are written, and the public sites they're published to
Articles
rework_success_hc_articleread writeList and read articles; create or edit one (title, summary, body with images, tags, category); archive it; update or publish many at once; mark one as helpful
rework_success_asset_uploadwriteUpload an image (PNG, JPG, WebP or GIF, up to 10 MB) and get the link to place in an article
Structure
rework_success_hc_categoryread writeCategories that organize your articles - they can nest
rework_success_hc_collectionread writeCollections on your public Help Center site - where articles get published
rework_success_hc_termread writeGlossary terms with their definitions, alternative spellings and related terms

Workflow - rework_wf_*

ToolAccessWhat it does
Find your way around
rework_wf_mereadWho you are (id, name, email)
rework_wf_dashboardreadYour dashboard - active / overdue / starred jobs and open todos, plus recent activity
rework_wf_flowtaskreadYour task inbox - the stages waiting on you (read-only)
Workflows & stages
rework_wf_workflowread writeList / open workflows & the board; create or update one
rework_wf_stageread writeThe ordered stages of a workflow - list, add, edit, reorder
rework_wf_formread writeThe workflow's compose form - its intake & stage fields
Jobs
rework_wf_jobread writeJobs (work items) - list & filter, open one, create or edit it (name, content, custom fields, assignee, deadline)
rework_wf_job_actionwriteMove a job through its pipeline - advance, send back, fail, reassign, move on the board, star, archive
rework_wf_todoread writeA job's checklist - list yours or a job's todos, add one, tick it off
Set-up
rework_wf_scheduleread writeRecurring schedules that spawn jobs - list, open, create / update, run now
rework_wf_labelread writeLabels & tags for jobs on a workflow
rework_wf_reasonread writeEnd-reasons shown when a job is completed or failed

Commerce - rework_commerce_*

ToolAccessWhat it does
rework_commerce_mereadWho you are (id, name, email)
Products
rework_commerce_catalogread writeCatalogs, their category tree and labels - list, open, create, edit, retire
rework_commerce_product_getreadList & filter products, find one by name / code / SKU, open it with its variants, see where it is used
rework_commerce_product_editwriteCreate & edit products (one-off or subscription price), retire them, set up options and add variants
Prices
rework_commerce_pricebookread writePrice books & currencies - list, open, create, edit, retire; which books apply to a customer
rework_commerce_price_entry_getreadPrices in a book or for a product, and the price at any quantity after rules
rework_commerce_price_entry_editwriteList a product in a price book, set or change its price, retire a price
rework_commerce_price_ruleread writeVolume tiers, volume discounts & custom adjustments by quantity

Inventory - rework_inventory_*

ToolAccessWhat it does
Setup
rework_inventory_mereadWho you are (id, name, email)
rework_inventory_warehouseread writeWarehouses - list, open, create (Inventory admins), rename, allow negative stock, reorder defaults, document numbering, owners
rework_inventory_locationread writeStorage locations - zones, aisles, racks, shelves & bins, many at once; the bin map of what is stored where
rework_inventory_catalogreadLook up products (from your Commerce catalog), suppliers and units of measure
rework_inventory_reasonread writeReason codes for counts, transfers and deliveries (Damaged, Expired, Customer order…)
Stock
rework_inventory_stock_getreadStock levels - on hand, reserved, available, cost - and each item's movement history
rework_inventory_stock_editwriteSet up stock (with an opening quantity), edit its details, retire it, set its reorder point
rework_inventory_itemreadEach item's availability across all warehouses, its recent activity and open documents
Stock documents
rework_inventory_transaction_getreadReceipts, deliveries, transfers and stock counts - list, search, counts by status, one document and its lines
rework_inventory_transaction_editwriteCreate a document with its lines, then post it - receive goods, ship them, transfer between warehouses, count stock - or cancel it before it is posted
rework_inventory_transaction_linewriteAdd or change a line on a document that isn't posted yet
Reports & team
rework_inventory_insightsreadDashboard, low stock & what to reorder, stock value, cost of goods delivered, and the change log
rework_inventory_commentread writeComments on a document or an item

Form - rework_form_*

ToolAccessWhat it does
Forms
rework_form_mereadWho you are (id, name, email)
rework_form_getreadFind forms, open one with its questions laid out by page and section and its after-submit rules in plain words, and get its public link (pre-filled if you like)
rework_form_editwriteCreate a form (with its questions), rename it, publish / unpublish, duplicate, pin, set its design theme, heading, submit button and spam check, save link pre-fill values, owners & followers
rework_form_fieldswriteQuestions and layout - replace them all, add, change or remove one; show-if logic, link pre-fill, sections, pages and side-by-side widths
rework_form_flowread writeWhat happens after submit - rules that email, call a webhook, show a message or redirect; check them before saving
Responses
rework_form_submissionread writeList and read responses, mark them active / spam / processed, export them, re-run the after-submit steps for one
rework_form_insightsreadViews, responses over time and by status, and a per-question summary of the answers
rework_form_groupread writeFolders to organise your forms - list, create, rename

Sign-in & security

📋 What's new - changelog