Quickstart
Get from zero to your first API call in under five minutes
You'll need a Servicebay account with admin access to at least one organisation — only admins can create API keys.
Get your API key
Sign in to the Developer Portal with your Servicebay credentials. Pick an organisation from the dropdown, open API Keys, and click Create API Key.
The key is shown only once at creation. Copy it somewhere safe before closing the dialog — you cannot retrieve it later.
Make your first request
Fetch your customers list. Replace YOUR_ORG_ID and the API key with
your own values.
curl -X GET \
'https://developer.servicebay.io/api/v1/organisations/YOUR_ORG_ID/customers' \
-H 'X-API-Key: sk_live_your_api_key'const res = await fetch(
"https://developer.servicebay.io/api/v1/organisations/YOUR_ORG_ID/customers",
{ headers: { "X-API-Key": "sk_live_your_api_key" } }
);
const { data } = await res.json();
console.log(data.customers);import requests
res = requests.get(
"https://developer.servicebay.io/api/v1/organisations/YOUR_ORG_ID/customers",
headers={"X-API-Key": "sk_live_your_api_key"},
)
print(res.json()["data"]["customers"])Read the response
Every Servicebay response uses the same envelope, so you only have to write the parsing code once.
{
"success": true,
"data": {
"customers": [
{
"id": "abc123",
"firstName": "John",
"lastName": "Doe",
"email": "john@example.com",
"phone": "+1234567890",
"createdAt": "2026-01-15T10:30:00Z"
}
],
"pagination": {
"limit": 50,
"hasMore": false,
"nextCursor": null
}
}
}Create something
POST a new customer back. firstName, lastName and email are
required; everything else is optional.
curl -X POST \
'https://developer.servicebay.io/api/v1/organisations/YOUR_ORG_ID/customers' \
-H 'X-API-Key: sk_live_your_api_key' \
-H 'Content-Type: application/json' \
-d '{
"firstName": "Jane",
"lastName": "Smith",
"email": "jane@example.com",
"phone": "+0987654321"
}'