Introduction

The Servicebay API lets you read and write everything an organisation does — customers, jobs, services, inventory, quotes, invoices, calendar, recurring agreements, and compliance forms — through one REST surface. Use it to embed Servicebay into your own products, build customer-facing intake forms, sync a warehouse, or connect an AI agent over MCP.

The API and developer portal are a Pro feature. An organisation qualifies when it is on a paid Pro subscription or in an in-app trial. Portal management requires an active org admin and TOTP.

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

API keys: scopes, allowed uses, expiry, rotate, and revocation.

OAuth

OAuth 2.1 with PKCE, scoped grants, and protected-resource metadata.

MCP

Connect AI agents through the Model Context Protocol.

MCP clients

Copy-paste setup for Claude, ChatGPT, Cursor, VS Code, and more.

Two-Factor Auth

TOTP is required for every developer-portal management call.

API Reference

Resource groups with interactive examples in cURL, JavaScript, and Python.

Error Handling

Status codes, error envelope, requestId, and retry pattern.

Pagination

Cursor-based pagination and list order fields.

Rate Limiting

100 requests per minute per key — and 503 when the limiter is down.

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.
AI agents — connect Claude, ChatGPT, Cursor, or any MCP client to the same REST API with least-privilege scopes.

Base URL

https://developer.servicebay.io/api/v1

MCP endpoint (OAuth or a scoped API key as Authorization: Bearer):

https://oauth.servicebay.io/mcp

Need a key?

Sign in to the Developer Portal with your Servicebay account (TOTP required), pick an organisation you actively admin, and create a key. New keys default to read-only, expire in 90 days, and may be used for both REST and MCP. The secret is shown only once.

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.