ReferenceReference by module
API reference
Every action and data model of every module — generated from the module manifests.
The whole Era API is generated from the module manifests: an action added to a module is, at once, an endpoint, an SDK method, an era command, an MCP tool and a section of this reference. These pages are generated from the same source, so they cannot drift from the API.
There are 56 modules, 985 actions, 300 data models and 769 events. The machine-readable contract: /api/v1/openapi.json (OpenAPI 3.1, version 2026-10-22).
QuickstartCreate a key, make your first call.AuthenticationAPI keys, OAuth and scopes.SDKEvery model and action, typed, with @getera/sdk.
How to read an action
- Endpoints — actions on one record live at
/api/v1/<resource>/{id}/actions/<verb>, actions on a collection at/api/v1/<resource>/actions/<verb>; every action also has its canonical addressPOST /api/v1/actions/<module.action>. - Needs —
<module>:<capability>. The key or token must carry it, and the person behind it must hold it in their role. - Preconditions — checked before the action runs; when one fails you get
409with its code. - Response —
{ "ok": true, "result": …, "events": [...] }.resultis what the action returned (usually the id of the record it wrote). - Writes take an
Idempotency-Keyheader; a retry with the same key replays the first result for 24 hours (Idempotency-Replayed: true).
Modules
| Module | Code | What it is for | Actions | Models | Events |
|---|---|---|---|---|---|
| Activity | activity | A live feed of everything that happens in your workspace. | 2 | 2 | 2 |
| AI | ai | Era, your assistant, and the AI agents you save — they work across every module. | 86 | 29 | 76 |
| Appointments | appointments | Online booking that respects your hours, breaks, time off and capacity. | 26 | 6 | 20 |
| Apps | apps | The apps and services you connected, and the updates sent to them. | 14 | 1 | 12 |
| Availability | availability | Opening hours, special days, time off and who offers which service. | 13 | 7 | 12 |
| Budgets | budgets | A spending plan per expense category, with alerts when you go over. | 6 | 2 | 5 |
| Build | build | Turn an idea into a real app: ERA composes it from its own building blocks, or your coding tools change your repository and ERA opens the pull request with a preview. | 10 | 2 | 6 |
| Campaigns | campaigns | Email, SMS and WhatsApp campaigns to your customers, with opens and clicks. | 16 | 7 | 12 |
| Catalog | catalog | Everything you sell or book — products, services, prices, categories and brands. | 25 | 9 | 19 |
| Comments | comments | Notes and replies on any record, for your team. | 9 | 3 | 9 |
| Creative Studio | creative | Describe it, see it, use it — product photos, posts, story videos, voice-overs and music, made by AI. | 26 | 5 | 8 |
| Customers | customers | One record for every customer, shared by every module. | 27 | 6 | 18 |
| Dashboards | dashboards | Dashboards of numbers, charts and tables built from your Base tables and your reports. | 6 | 2 | 3 |
| Discounts | discounts | Promotions and discount codes — sales, order deals and free gifts. | 12 | 10 | 13 |
| Document requests | lead_documents | Ask a lead for documents with a link — no sign-in needed. | 7 | 3 | 6 |
| Era Desktop | station | Your Era Desktop’s chats, approvals waiting, plans, todos and automations — kept in Era, yours only. | 6 | 0 | 6 |
| Era insights | insights | Era tells you before you ask: what changed in your work, with sources, caveats and the next step — yours only. | 6 | 2 | 0 |
| Events | happenings | One-off events with tickets, registrations and a check-in list. | 11 | 3 | 9 |
| Files | files | Every file you upload, create or receive, in folders with previews. | 14 | 3 | 16 |
| Finance | finance | What customers owe and pay, and what the business spends. | 42 | 13 | 30 |
| Forms | forms | Public forms anyone can fill in; answers arrive as leads or Base records. | 7 | 3 | 8 |
| Gift cards | gift_cards | Gift cards with a code, a balance, an expiry date and a full history. | 11 | 3 | 7 |
| Group classes | group_classes | A weekly class timetable with places, instructors, bookings and attendance. | 12 | 4 | 11 |
| Help center | help_center | Help articles in categories, for your customers and your support team. | 8 | 2 | 7 |
| Home service | field_service | Visits at the customer’s address — who goes, when they arrive, signature and photos. | 5 | 1 | 7 |
| Inbox | inbox | Every channel in one inbox — conversations, replies, teams and who answers. | 63 | 22 | 45 |
| Integrations | integrations | Marketplaces, online shops, carriers, e-invoice and Google reviews, synced into your own orders, products, stock and customers. | 22 | 8 | 22 |
| Invoices | invoices | Numbered invoices and credit notes, with tax on every line. | 14 | 4 | 12 |
| Languages | i18n | The languages you work and publish in, and your translations. | 4 | 2 | 4 |
| Meetings | meetings | Era joins your meetings — with a notetaker bot or botless from your computer — briefs you before, and after writes the notes, tasks, follow-up email and next steps. | 33 | 4 | 16 |
| Notifications | notifications | Who is told about what — by email, SMS, WhatsApp or in the app. | 20 | 7 | 18 |
| Organization | organizations | Your business, its workspaces, branding and the people in it. | 17 | 1 | 19 |
| Packages | packages | Monthly packages that bundle services and classes, with sessions counted. | 7 | 3 | 6 |
| Platform | platform | API keys, webhooks and background jobs for connecting other tools. | 19 | 1 | 16 |
| Popups | popups | Website popups, with targeting and A/B conversion counts. | 4 | 2 | 2 |
| Privacy | privacy | Personal-data requests — export or erase a customer’s data, with a record kept. | 7 | 1 | 6 |
| Product types | attributes | Product types and reusable attributes such as colour, size and material. | 14 | 8 | 10 |
| Quotes | quotes | Price quotes with a PDF and a link the customer can accept or decline. | 13 | 5 | 12 |
| Reports | reports | Sales and money reports, and who is allowed to see each one. | 5 | 2 | 4 |
| Resources | resources | Rooms, pitches, cars, chairs and equipment people book — by the hour or by the day. | 7 | 3 | 7 |
| Sales | crm | Leads, the calls that follow them up, and the partners who send them. | 31 | 11 | 27 |
| Security & Access | security_access | Roles, and what each role can see and do. | 14 | 6 | 15 |
| Settings | settings | Settings for your business, this workspace and each module. | 1 | 2 | 1 |
| Shared views & forms | data_sharing | Share a Base view with a private link, or publish it as a form. | 3 | 1 | 3 |
| Shop | retail | Sales channels, stock, shipping and orders — from basket to doorstep. | 74 | 33 | 56 |
| Subscriptions | subscriptions | Recurring plans at a fixed price, renewed and billed every period. | 9 | 2 | 9 |
| Table sync | data_sync | Keep a table filled from an outside database, Airtable, a Google Sheet or a CSV link — or in step with your customers, both ways. | 7 | 2 | 8 |
| Tables | data | Tables of your own, and extra fields on any record. | 37 | 0 | 27 |
| Tags | tags | One shared set of tags for every record, in your own colours. | 6 | 2 | 6 |
| Tax | tax | Tax rates by country and product type, applied to every sale. | 7 | 4 | 4 |
| Team | employees | Your team directory and staff files — hiring, onboarding and leaving. | 4 | 1 | 4 |
| Views | view_grid | Saved lists — the columns, filters and order you chose. | 5 | 2 | 3 |
| Voice | voice | Your Eras answer the phone and your website by voice, book, take messages and file every call in the Inbox. | 22 | 3 | 13 |
| Website | site | Your website: its pages and menu, design, addresses, posts, FAQs and legal pages. | 76 | 22 | 44 |
| Work | work | Ask once: Era plans it, splits it across workers that run in parallel, and brings back finished work to use or publish. | 23 | 5 | 18 |
| Workflows | workflows | Automations that react to what happens, or run on a schedule, and do the work for you. | 10 | 3 | 10 |