What's available

The parts of a service business we've already built. Take what you need, ignore the rest.

Sarah needs her customers and her crews in the system before anything else. A clinic down the road starts the same way — the people first, then whatever else the business needs as it comes online.

Everything is a module, and each one is switched on per site. You take what you need.

The list

Module	What it's for	Guide	Reference
Customers	Who they are, where they live, what they like, whether they're still active	Guide	Clients
Staff	Who works where, availability, time off	Guide	Employees
Services	What you sell, what it costs, how it's grouped	Guide	Services
Scheduling	Recurring plans and the appointments they generate	Guide	Schedules
Sites and roles	Site details, users and permissions inside a site	Guide	Organizations

More modules are on the way

Bookings, invoicing, services, products and more are built and being hardened with early customers now. Each one appears here — guide and API reference together — the day it goes live, so anything you can read about is something you can call.

Where the paths are

Business endpoints all sit under /api/modules/{module}:

/api/modules/clients
/api/modules/employees/users
/api/modules/organizations/audit-logs

Not /api/clients. Two things are always needed:

X-Location-Id, naming the site — see Working with sites
A credential with the right scope — see Who can do what

Switching a module on

If a module isn't switched on for a site, its endpoints return 403 however your key is scoped. That catches people out, because it looks identical to a permissions problem.

Switch modules on from the site's row on the Locations page. You can set it per site, or across a whole group at once.

Getting 403 on a module endpoint?

Check whether the module is switched on before you start adjusting scopes. If it isn't, no scope change will help, and you can spend a long afternoon on the wrong problem.

What every module guide covers

Same shape each time, so you can skim one you've never used and know where to look:

What it's for, in plain language
Before you start — what needs switching on and granting
What the thing looks like — the fields
The endpoints — with links into the reference
Creating, reading, updating, deleting — in both integration styles
Whatever else hangs off it
What you get told about — its webhook events
What to grant — scopes
What goes wrong — the failures specific to this module
Recipes — real jobs, start to finish

Customers

Start with the worked example.

Your first hour

If you haven't made a request yet.