Introduction
Welcome to the Servicebay API documentation
The Servicebay API lets you read and write everything an organisation does — customers, jobs, services, inventory, quotes, invoices, and the calendar — through one consistent REST surface. Use it to embed Servicebay into your own products, build customer-facing intake forms, or sync data into a warehouse.
Start here
Quickstart
Get a key, make your first request, and parse the response in under five minutes.
Developer Portal
Create keys, test endpoints in the playground, and manage OAuth connections.
Authentication
How API keys work, how they're scoped, and how to keep them safe.
OAuth
Let users connect their organisation to your app with scoped, revocable permissions.
MCP
Connect AI agents to Servicebay through the Model Context Protocol.
Two-Factor Auth
TOTP enforcement at portal sign-in — enrolment, verification, recovery.
API Reference
Thirteen resource groups with interactive examples in cURL, JavaScript, and Python.
Error Handling
Status codes, common errors, and a robust retry pattern.
Pagination
Cursor-based pagination across every list endpoint.
Rate Limiting
100 requests per minute per key — and how to back off cleanly.
What you can build
- Customer intake forms — look up an existing customer by phone or email, then book a job in one round-trip.
- Field service dashboards — pull jobs, quotes, and invoices for a specific technician or customer and render them in your own UI.
- Accounting integrations — sync invoices and payment status into your accounting tool of choice.
- Catalogue mirrors — keep an external storefront in sync with your service templates and inventory items.
Base URL
https://developer.servicebay.io/api/v1Need a key?
Sign in to the Developer Portal with your Servicebay account, pick an organisation, and create a key. Keys are shown only once at creation, so copy them somewhere safe before closing the dialog.
Prefer clicking to coding?
After creating a key, open the API Playground in the same browser tab to try any endpoint live. See the Developer Portal guide for how organisation selection, key caching, and connected apps work.