Developer API v1.0

Developer Portal

Access jobs, customers, services, inventory, quotes, invoices and the calendar through one consistent REST API. Everything you need to embed Servicebay into your own products and workflows.

Get Your API KeyView Documentation

Everything you need to integrate

Seven core resources, one consistent envelope. Predictable URLs, JSON in and out, and pagination on every list endpoint.

Jobs
Create, schedule and update service jobs. Set serviceTime, endTime and a location type — instore, offsite, or remote.
Customers
Full customer CRUD plus a server-side lookup endpoint that finds a customer by exact phone or email match.
Services
Maintain reusable service templates with fixed, hourly or variable pricing and warranty defaults.
Inventory
Track stock items with SKU, GTIN, weight and stock counts. Look up parts by exact SKU.
Quotes
Create, send and track quotes linked to a customer or job. Auto-incrementing quote numbers.
Invoices
Generate invoices with deposits, balances and discounts. Track sent, viewed and paid status.
Calendar Events
Standalone events or events linked to a job. Filter by date range, technician or job ID.
Customer lookup by phone or email
A dedicated /customers/lookup endpoint runs an exact-match query server-side. Wire it into a customer-facing intake form to find an existing record before booking a job.
Two-factor authentication enforced
If your Servicebay account has 2FA enabled, the developer portal requires a TOTP code at every sign-in. No opt-out — your API keys live behind two factors.

Simple, RESTful API

Our API follows REST conventions with predictable URLs, standard HTTP methods, and JSON responses. Get started in minutes with any programming language.

  • API-key authentication with X-API-Key header
  • 100 requests per minute rate limit per key
  • Cursor-based pagination on every list endpoint
  • OpenAPI 3.1 specification — generate clients in any language
lookup-and-book.sh
# 1. Look up the customer by phone
curl 'https://developer.servicebay.io/api/v1/organisations/{orgId}/customers/lookup?phone=%2B1234567890' \
  -H 'X-API-Key: sk_live_your_api_key'

# 2. Book a job for them
curl -X POST 'https://developer.servicebay.io/api/v1/organisations/{orgId}/tickets' \
  -H 'X-API-Key: sk_live_your_api_key' \
  -H 'Content-Type: application/json' \
  -d '{
    "customerId": "abc123",
    "customerName": "Jane Doe",
    "serviceTime": "2025-05-10T14:00:00Z",
    "endTime":     "2025-05-10T15:00:00Z",
    "serviceLocation": "instore"
  }'

Ready to get started?

Sign in with your Servicebay account to generate API keys and start building.

Sign In to Get Started