Glossary
The API uses eight nouns. Each one has one meaning. Two of them collide with the words the dashboard puts on screen, and the collision is on purpose rather than an oversight, so it is written down here instead of being papered over.
In the API, staff is a bookable calendar. It is not a person with a
login.
A calendar can belong to a person, and usually does. It does not have to. A room, a chair or a piece of equipment is also a calendar, because the thing being booked is the slot, not the human.
A person who signs in to the dashboard is a member. A member can be linked to one calendar, or to none.
The dashboard labels this “Calendars”. The API noun is staff — the route is
GET /v1/staff, the plan dimension is staff, and neither changes. If you are
mapping our vocabulary onto yours, map it here and once.
account
Section titled “account”The billing entity. An account holds the plan, the payment method and every cap. It can own more than one workspace.
Every cap in this product is counted at the account, not at the workspace. Two workspaces on one account share one booking allowance.
workspace
Section titled “workspace”One business, or one location of one business. A workspace holds services, calendars, working hours, bookings and customers. It has a slug, and the slug is what a customer’s booking page is addressed by.
An API key belongs to a workspace. An account key reaches all of them.
service
Section titled “service”What the workspace sells: a thing with a name, a duration and a price. A booking is always for exactly one service.
Which calendars can deliver which service is a per-service list — see
GET /v1/services/{id}/staff.
One active calendar, counted against the account’s plan. Deactivating a
calendar frees its seat; deleting is not required, and DELETE /v1/staff/{id}
deactivates rather than deletes.
“Seat” is a billing word and never appears in a request or a response. The wire
value for this cap is staff — see the errors guide.
booking
Section titled “booking”One appointment: a service, a calendar, a customer and a time range.
A booking is pending, confirmed or cancelled. pending means the slot is
held and the customer has not yet entered their 6-digit code. A pending hold
occupies the slot, and it lapses on its own if nobody verifies it.
customer
Section titled “customer”The person the appointment is for. A customer is a record on the workspace,
identified by email, and is created by the booking that first names them. A
customer never signs in. The manage link in their email carries a token, and
that token is the only credential on the /v1/public routes.
calendar
Section titled “calendar”The same thing as staff. Listed here because the dashboard says “calendar”
everywhere the API says staff, and one of the two words is going to be the
one you searched for.