Resource libraryFounder guides, calculators & references across 14 industries FAQPricing, GST, migration and what we do not do yet Guides & researchAU small-business research, guides & tax tips Help CentreHow-to articles for every OneBookPlus module Free ToolsCalculators & generators: free, no signup GlossaryPlain-English business, tax & accounting terms ChangelogEvery release, as it ships Ask Plus (AI)Ask a product question, get an instant answer

Popular Free Tools

Tax Refund Calculator Income Tax Calculator GST Calculator Salary Calculator ABN Lookup Superannuation Calculator Invoice Generator View all tools

About usOur story & why we built OneBookPlus The founderWho's behind OneBookPlus CustomersHow Australian businesses run on OneBookPlus ReviewsEvery Google, Trustpilot, G2 & App Store review, unedited RoadmapWhat we're building next Security & TrustHow your business data is protected System StatusService availability & incident log PartnersPartner with OneBookPlus ContactTalk to a human

Try a live demo, it's free Book a Demo Sign In Start free

OneBookPlus Public API · v1.0.0

API Reference

Every endpoint on this page is rendered from the same OpenAPI 3.1 document the API itself serves, so the reference can't drift from the implementation. The stable v1 surface covers contacts, invoices, quotes and bookings; breaking changes only ship under the v2 preview.

Download the raw OpenAPI spec (v1)View the API changelog (JSON)Back to the developer overview

Base URL & authentication

All v1 requests are made against a single base URL. Authentication uses a bearer API key issued from your dashboard (Settings → API keys); keys are scoped to one business account with read or read-write permissions. API access requires developer-access approval on your account.

API keys issued from /dashboard/settings/api-keys. Format: `obp_live_<random>` (prefix `obp_`). Send as `Authorization: Bearer obp_...`.

A v2 preview of the same surface is served under /api/v2 (spec at /api/v2/openapi.json), identical today, and the only place breaking changes will land.

Request template

curl https://onebookplus.com.au/api/v1/ping \
  -H "Authorization: Bearer obp_..."

# Base URL: https://onebookplus.com.au/api/v1
# Keys are issued at /dashboard/settings/api-keys

Conventions: pagination, errors, rate limits

Cursor pagination

List endpoints return { data, next_cursor }. Pass ?cursor= to fetch the next page; next_cursor is null when exhausted. limit accepts 1 to 200 (default 50), and updated_since filters by ISO 8601 timestamp for incremental syncs.

Errors

Failures return a JSON body of { error } with an optional field naming the failing validator on 400s. Statuses used: 400, 401, 403, 404, 409, 415, 429 and 500 (see the Error schema).

Rate limits

Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers. The default limit is 60 requests per minute per API key, with tighter per-endpoint caps on write operations; 429 responses include Retry-After.

Endpoints

25 operations across 7 resource groups.

Contacts

GET/contactsList contacts

Parameters

Name	In	Type	Required	Description
limit	query	integer	No	Max rows to return (1-200). Min: 1. Max: 200. Default: 50.
cursor	query	string (uuid)	No	Opaque UUID cursor from a previous response's next_cursor.
updated_since	query	string (date-time)	No	Only return rows with updated_at >= this ISO 8601 timestamp.
email	query	string (email)	No	Exact (case-insensitive) email match. Powers Find Contact.

Responses

Status	Description	Body
200	OK	{ data: array of Contact, next_cursor: string \| null (uuid) }
400	Error	Error
401	Error	Error
403	Error	Error
404	Error	Error
409	Error	Error
415	Error	Error
429	Too Many Requests	RateLimitError
500	Error	Error

POST/contactsCreate a contact

Request body (application/json, ContactCreate)

Field	Type	Required	Description
email	string (email)	Yes	n/a
first_name	string \| null	No	n/a
last_name	string \| null	No	n/a
phone	string \| null	No	n/a
company_name	string \| null	No	n/a
city	string \| null	No	n/a
state	string \| null	No	n/a
postcode	string \| null	No	n/a

Responses

Status	Description	Body
201	Created	{ data: Contact }
400	Error	Error
401	Error	Error
403	Error	Error
404	Error	Error
409	Error	Error
415	Error	Error
429	Too Many Requests	RateLimitError
500	Error	Error

GET/contacts/{id}Get a contact

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes	n/a

Responses

Status	Description	Body
200	OK	{ data: Contact }
400	Error	Error
401	Error	Error
403	Error	Error
404	Error	Error
409	Error	Error
415	Error	Error
429	Too Many Requests	RateLimitError
500	Error	Error

PATCH/contacts/{id}Update a contact

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes	n/a

Request body (application/json, ContactUpdate)

At least one field must be supplied.

Field	Type	Required	Description
email	string \| null (email)	No	n/a
first_name	string \| null	No	n/a
last_name	string \| null	No	n/a
phone	string \| null	No	n/a
company_name	string \| null	No	n/a
city	string \| null	No	n/a
state	string \| null	No	n/a
postcode	string \| null	No	n/a

Responses

Status	Description	Body
200	OK	{ data: Contact }
400	Error	Error
401	Error	Error
403	Error	Error
404	Error	Error
409	Error	Error
415	Error	Error
429	Too Many Requests	RateLimitError
500	Error	Error

DELETE/contacts/{id}Soft-delete a contact

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes	n/a

Responses

Status	Description	Body
204	No Content (soft-deleted).	n/a
400	Error	Error
401	Error	Error
403	Error	Error
404	Error	Error
409	Error	Error
415	Error	Error
429	Too Many Requests	RateLimitError
500	Error	Error

Invoices

GET/invoicesList invoices

Parameters

Name	In	Type	Required	Description
limit	query	integer	No	Max rows to return (1-200). Min: 1. Max: 200. Default: 50.
cursor	query	string (uuid)	No	Opaque UUID cursor from a previous response's next_cursor.
updated_since	query	string (date-time)	No	Only return rows with updated_at >= this ISO 8601 timestamp.
status	query	string	No	Only return invoices with this status (e.g. paid). One of: draft, sent, viewed, partial, paid, overdue, cancelled.
number	query	string	No	Exact invoice_number match. Powers Find Invoice.

Responses

Status	Description	Body
200	OK	{ data: array of Invoice, next_cursor: string \| null (uuid) }
400	Error	Error
401	Error	Error
403	Error	Error
404	Error	Error
409	Error	Error
415	Error	Error
429	Too Many Requests	RateLimitError
500	Error	Error

GET/invoices/{id}Get an invoice

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes	n/a

Responses

Status	Description	Body
200	OK	{ data: Invoice }
400	Error	Error
401	Error	Error
403	Error	Error
404	Error	Error
409	Error	Error
415	Error	Error
429	Too Many Requests	RateLimitError
500	Error	Error

Bookings

GET/bookingsList bookings

Parameters

Name	In	Type	Required	Description
limit	query	integer	No	Max rows to return (1-200). Min: 1. Max: 200. Default: 50.
cursor	query	string (uuid)	No	Opaque UUID cursor from a previous response's next_cursor.
updated_since	query	string (date-time)	No	Only return rows with updated_at >= this ISO 8601 timestamp.

Responses

Status	Description	Body
200	OK	{ data: array of Booking, next_cursor: string \| null (uuid) }
400	Error	Error
401	Error	Error
403	Error	Error
404	Error	Error
409	Error	Error
415	Error	Error
429	Too Many Requests	RateLimitError
500	Error	Error

POST/bookingsCreate a booking

Request body (application/json, BookingCreate)

Field	Type	Required	Description
contact_id	string (uuid)	Yes	n/a
service_name	string	Yes	n/a
start_time	string (date-time)	Yes	n/a
end_time	string \| null (date-time)	No	Defaults to start_time + 60 minutes if omitted.
notes	string \| null	No	n/a

Responses

Status	Description	Body
201	Created	{ data: Booking }
400	Error	Error
401	Error	Error
403	Error	Error
404	Error	Error
409	Error	Error
415	Error	Error
429	Too Many Requests	RateLimitError
500	Error	Error

GET/bookings/{id}Get a booking

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes	n/a

Responses

Status	Description	Body
200	OK	{ data: Booking }
400	Error	Error
401	Error	Error
403	Error	Error
404	Error	Error
409	Error	Error
415	Error	Error
429	Too Many Requests	RateLimitError
500	Error	Error

PATCH/bookings/{id}Update a booking

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes	n/a

Request body (application/json, BookingUpdate)

At least one field must be supplied.

Field	Type	Required	Description
status	string	No	One of: cancelled, confirmed, completed, no_show.
notes	string \| null	No	n/a
start_time	string (date-time)	No	n/a
end_time	string (date-time)	No	n/a

Responses

Status	Description	Body
200	OK	{ data: Booking }
400	Error	Error
401	Error	Error
403	Error	Error
404	Error	Error
409	Error	Error
415	Error	Error
429	Too Many Requests	RateLimitError
500	Error	Error

Quotes

GET/quotesList quotes

Parameters

Name	In	Type	Required	Description
limit	query	integer	No	Max rows to return (1-200). Min: 1. Max: 200. Default: 50.
cursor	query	string (uuid)	No	Opaque UUID cursor from a previous response's next_cursor.
updated_since	query	string (date-time)	No	Only return rows with updated_at >= this ISO 8601 timestamp.
status	query	string	No	Only return quotes with this status (e.g. accepted). One of: draft, sent, viewed, accepted, declined, expired, converted.

Responses

Status	Description	Body
200	OK	{ data: array of Quote, next_cursor: string \| null (uuid) }
400	Error	Error
401	Error	Error
403	Error	Error
404	Error	Error
409	Error	Error
415	Error	Error
429	Too Many Requests	RateLimitError
500	Error	Error

POST/quotesCreate a quote

Request body (application/json, QuoteCreate)

Field	Type	Required	Description
contact_id	string (uuid)	Yes	n/a
total	number	Yes	Min: 0.
currency	string \| null	No	3-letter ISO 4217 code. Defaults to AUD. Pattern: ^[A-Z]{3}$
valid_until	string \| null (date-time)	No	Defaults to 30 days from today.
line_items	array of object	No	Accepted for forward compatibility but currently ignored server-side — the canonical line-item table is not reconciled from API writes yet.

Responses

Status	Description	Body
201	Created	{ data: Quote }
400	Error	Error
401	Error	Error
403	Error	Error
404	Error	Error
409	Error	Error
415	Error	Error
429	Too Many Requests	RateLimitError
500	Error	Error

GET/quotes/{id}Get a quote

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes	n/a

Responses

Status	Description	Body
200	OK	{ data: Quote }
400	Error	Error
401	Error	Error
403	Error	Error
404	Error	Error
409	Error	Error
415	Error	Error
429	Too Many Requests	RateLimitError
500	Error	Error

PATCH/quotes/{id}Update a quote

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes	n/a

Request body (application/json, QuoteUpdate)

At least one field must be supplied.

Field	Type	Required	Description
status	string	No	One of: draft, sent, viewed, accepted, declined, expired, converted.
total	number	No	Min: 0.
valid_until	string (date-time)	No	n/a

Responses

Status	Description	Body
200	OK	{ data: Quote }
400	Error	Error
401	Error	Error
403	Error	Error
404	Error	Error
409	Error	Error
415	Error	Error
429	Too Many Requests	RateLimitError
500	Error	Error

Jobs

GET/jobsList jobs

Parameters

Name	In	Type	Required	Description
limit	query	integer	No	Max rows to return (1-200). Min: 1. Max: 200. Default: 50.
cursor	query	string (uuid)	No	Opaque UUID cursor from a previous response's next_cursor.
updated_since	query	string (date-time)	No	Only return rows with updated_at >= this ISO 8601 timestamp.
status	query	string	No	Only return jobs with this status (e.g. completed). One of: quoted, scheduled, in_progress, on_hold, completed, invoiced, cancelled.
job_number	query	string	No	Exact job_number match. Powers Find Job.

Responses

Status	Description	Body
200	OK	{ data: array of Job, next_cursor: string \| null (uuid) }
400	Error	Error
401	Error	Error
403	Error	Error
404	Error	Error
409	Error	Error
415	Error	Error
429	Too Many Requests	RateLimitError
500	Error	Error

POST/jobsCreate a job

Request body (application/json, JobCreate)

Field	Type	Required	Description
title	string	Yes	n/a
contact_id	string \| null (uuid)	No	n/a
job_type	string \| null	No	n/a
priority	string \| null	No	n/a
status	string	No	Defaults to quoted. One of: quoted, scheduled, in_progress, on_hold, completed, invoiced, cancelled.
scheduled_start	string \| null (date-time)	No	n/a
scheduled_end	string \| null (date-time)	No	n/a
site_address	string \| null	No	n/a
site_suburb	string \| null	No	n/a
site_state	string \| null	No	n/a
site_postcode	string \| null	No	n/a
estimated_total	number \| null	No	Min: 0.

Responses

Status	Description	Body
201	Created	{ data: Job }
400	Error	Error
401	Error	Error
403	Error	Error
404	Error	Error
409	Error	Error
415	Error	Error
429	Too Many Requests	RateLimitError
500	Error	Error

GET/jobs/{id}Get a job

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes	n/a

Responses

Status	Description	Body
200	OK	{ data: Job }
400	Error	Error
401	Error	Error
403	Error	Error
404	Error	Error
409	Error	Error
415	Error	Error
429	Too Many Requests	RateLimitError
500	Error	Error

PATCH/jobs/{id}Update a job

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes	n/a

Request body (application/json, JobUpdate)

At least one field must be supplied.

Field	Type	Required	Description
title	string	No	n/a
status	string	No	One of: quoted, scheduled, in_progress, on_hold, completed, invoiced, cancelled.
job_type	string \| null	No	n/a
priority	string \| null	No	n/a
scheduled_start	string \| null (date-time)	No	n/a
scheduled_end	string \| null (date-time)	No	n/a
estimated_total	number \| null	No	Min: 0.
actual_total	number \| null	No	Min: 0.

Responses

Status	Description	Body
200	OK	{ data: Job }
400	Error	Error
401	Error	Error
403	Error	Error
404	Error	Error
409	Error	Error
415	Error	Error
429	Too Many Requests	RateLimitError
500	Error	Error

Webhooks

Subscribe to events (invoice.paid, quote.accepted, booking.created, contact.created, …). Deliveries are POSTed to your URL, signed with HMAC-SHA256 in the X-OBP-Signature header using the secret returned once at creation. Powers the Zapier integration's instant triggers.

GET/webhooksList webhook subscriptions

Parameters

Name	In	Type	Required	Description
limit	query	integer	No	Max rows to return (1-200). Min: 1. Max: 200. Default: 50.
cursor	query	string (uuid)	No	Opaque UUID cursor from a previous response's next_cursor.
updated_since	query	string (date-time)	No	Only return rows with updated_at >= this ISO 8601 timestamp.

Responses

Status	Description	Body
200	OK	{ data: array of WebhookSubscription, next_cursor: string \| null (uuid) }
400	Error	Error
401	Error	Error
403	Error	Error
404	Error	Error
409	Error	Error
415	Error	Error
429	Too Many Requests	RateLimitError
500	Error	Error

POST/webhooksCreate a webhook subscription

Request body (application/json, WebhookCreate)

Field	Type	Required	Description
url	string (uri)	Yes	HTTPS URL to POST deliveries to. Must be a public host.
events	array of string	Yes	Events to subscribe to. Use ["*"] for all events.
description	string \| null	No	n/a

Responses

Status	Description	Body
201	Created	{ data: WebhookSubscriptionWithSecret }
400	Error	Error
401	Error	Error
403	Error	Error
404	Error	Error
409	Error	Error
415	Error	Error
429	Too Many Requests	RateLimitError
500	Error	Error

GET/webhooks/{id}Get a webhook subscription

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes	n/a

Responses

Status	Description	Body
200	OK	{ data: WebhookSubscription }
400	Error	Error
401	Error	Error
403	Error	Error
404	Error	Error
409	Error	Error
415	Error	Error
429	Too Many Requests	RateLimitError
500	Error	Error

PATCH/webhooks/{id}Update a webhook subscription

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes	n/a

Request body (application/json, WebhookUpdate)

At least one field must be supplied.

Field	Type	Required	Description
url	string (uri)	No	n/a
events	array of string	No	n/a
enabled	boolean	No	n/a
description	string \| null	No	n/a

Responses

Status	Description	Body
200	OK	{ data: WebhookSubscription }
400	Error	Error
401	Error	Error
403	Error	Error
404	Error	Error
409	Error	Error
415	Error	Error
429	Too Many Requests	RateLimitError
500	Error	Error

DELETE/webhooks/{id}Delete a webhook subscription (unsubscribe)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes	n/a

Responses

Status	Description	Body
204	No Content (soft-deleted).	n/a
400	Error	Error
401	Error	Error
403	Error	Error
404	Error	Error
409	Error	Error
415	Error	Error
429	Too Many Requests	RateLimitError
500	Error	Error

Object schemas

The 19 object models referenced by request and response bodies above.

Error

Field	Type	Required	Description
error	string	Yes	n/a
field	string	No	Field name when a validator fails (400 responses).

RateLimitError

Field	Type	Required	Description
error	string	Yes	n/a
retry_after_ms	integer	No	Min: 0.

Contact

Field	Type	Required	Description
id	string (uuid)	Yes	n/a
email	string \| null (email)	No	n/a
first_name	string \| null	No	n/a
last_name	string \| null	No	n/a
phone	string \| null	No	n/a
company_name	string \| null	No	n/a
city	string \| null	No	n/a
state	string \| null	No	n/a
postcode	string \| null	No	n/a
created_at	string (date-time)	Yes	n/a
updated_at	string (date-time)	Yes	n/a

ContactCreate

Field	Type	Required	Description
email	string (email)	Yes	n/a
first_name	string \| null	No	n/a
last_name	string \| null	No	n/a
phone	string \| null	No	n/a
company_name	string \| null	No	n/a
city	string \| null	No	n/a
state	string \| null	No	n/a
postcode	string \| null	No	n/a

ContactUpdate

At least one field must be supplied.

Field	Type	Required	Description
email	string \| null (email)	No	n/a
first_name	string \| null	No	n/a
last_name	string \| null	No	n/a
phone	string \| null	No	n/a
company_name	string \| null	No	n/a
city	string \| null	No	n/a
state	string \| null	No	n/a
postcode	string \| null	No	n/a

Invoice

Field	Type	Required	Description
id	string (uuid)	Yes	n/a
invoice_number	string	Yes	n/a
contact_id	string \| null (uuid)	No	n/a
status	string	Yes	n/a
issue_date	string \| null (date)	No	n/a
due_date	string \| null (date)	No	n/a
total	number	Yes	n/a
currency	string	Yes	Exactly 3 characters.
paid_at	string \| null (date-time)	No	n/a
created_at	string (date-time)	Yes	n/a
updated_at	string (date-time)	Yes	n/a

Booking

Field	Type	Required	Description
id	string (uuid)	Yes	n/a
contact_id	string \| null (uuid)	No	n/a
service_name	string \| null	No	n/a
start_time	string (date-time)	Yes	n/a
end_time	string (date-time)	Yes	n/a
status	string	Yes	One of: cancelled, confirmed, completed, no_show.
notes	string \| null	No	n/a
created_at	string (date-time)	Yes	n/a
updated_at	string (date-time)	Yes	n/a

BookingCreate

Field	Type	Required	Description
contact_id	string (uuid)	Yes	n/a
service_name	string	Yes	n/a
start_time	string (date-time)	Yes	n/a
end_time	string \| null (date-time)	No	Defaults to start_time + 60 minutes if omitted.
notes	string \| null	No	n/a

BookingUpdate

At least one field must be supplied.

Field	Type	Required	Description
status	string	No	One of: cancelled, confirmed, completed, no_show.
notes	string \| null	No	n/a
start_time	string (date-time)	No	n/a
end_time	string (date-time)	No	n/a

Quote

Field	Type	Required	Description
id	string (uuid)	Yes	n/a
quote_number	string	Yes	n/a
contact_id	string \| null (uuid)	No	n/a
status	string	Yes	One of: draft, sent, viewed, accepted, declined, expired, converted.
issue_date	string \| null (date)	No	n/a
valid_until	string \| null (date)	No	n/a
total	number	Yes	n/a
currency	string	Yes	Exactly 3 characters.
created_at	string (date-time)	Yes	n/a
updated_at	string (date-time)	Yes	n/a

QuoteCreate

Field	Type	Required	Description
contact_id	string (uuid)	Yes	n/a
total	number	Yes	Min: 0.
currency	string \| null	No	3-letter ISO 4217 code. Defaults to AUD. Pattern: ^[A-Z]{3}$
valid_until	string \| null (date-time)	No	Defaults to 30 days from today.
line_items	array of object	No	Accepted for forward compatibility but currently ignored server-side — the canonical line-item table is not reconciled from API writes yet.

QuoteUpdate

At least one field must be supplied.

Field	Type	Required	Description
status	string	No	One of: draft, sent, viewed, accepted, declined, expired, converted.
total	number	No	Min: 0.
valid_until	string (date-time)	No	n/a

Job

Field	Type	Required	Description
id	string (uuid)	Yes	n/a
job_number	string	Yes	n/a
title	string	Yes	n/a
status	string	Yes	One of: quoted, scheduled, in_progress, on_hold, completed, invoiced, cancelled.
job_type	string \| null	No	n/a
priority	string \| null	No	n/a
contact_id	string \| null (uuid)	No	n/a
customer_name	string \| null	No	n/a
customer_email	string \| null	No	n/a
customer_phone	string \| null	No	n/a
site_address	string \| null	No	n/a
site_suburb	string \| null	No	n/a
site_state	string \| null	No	n/a
site_postcode	string \| null	No	n/a
scheduled_start	string \| null (date-time)	No	n/a
scheduled_end	string \| null (date-time)	No	n/a
actual_start	string \| null (date-time)	No	n/a
actual_end	string \| null (date-time)	No	n/a
estimated_total	number \| null	No	n/a
actual_total	number \| null	No	n/a
quote_id	string \| null (uuid)	No	n/a
invoice_id	string \| null (uuid)	No	n/a
created_at	string (date-time)	Yes	n/a
updated_at	string (date-time)	Yes	n/a

JobCreate

Field	Type	Required	Description
title	string	Yes	n/a
contact_id	string \| null (uuid)	No	n/a
job_type	string \| null	No	n/a
priority	string \| null	No	n/a
status	string	No	Defaults to quoted. One of: quoted, scheduled, in_progress, on_hold, completed, invoiced, cancelled.
scheduled_start	string \| null (date-time)	No	n/a
scheduled_end	string \| null (date-time)	No	n/a
site_address	string \| null	No	n/a
site_suburb	string \| null	No	n/a
site_state	string \| null	No	n/a
site_postcode	string \| null	No	n/a
estimated_total	number \| null	No	Min: 0.

JobUpdate

At least one field must be supplied.

Field	Type	Required	Description
title	string	No	n/a
status	string	No	One of: quoted, scheduled, in_progress, on_hold, completed, invoiced, cancelled.
job_type	string \| null	No	n/a
priority	string \| null	No	n/a
scheduled_start	string \| null (date-time)	No	n/a
scheduled_end	string \| null (date-time)	No	n/a
estimated_total	number \| null	No	Min: 0.
actual_total	number \| null	No	Min: 0.

WebhookSubscription

Field	Type	Required	Description
id	string (uuid)	Yes	n/a
url	string (uri)	Yes	n/a
events	array of string	Yes	["*"] means all events.
enabled	boolean	Yes	n/a
description	string \| null	No	n/a
created_at	string (date-time)	Yes	n/a
last_delivery_at	string \| null (date-time)	No	n/a
last_delivery_status	integer \| null	No	HTTP status of the most recent delivery (0/-1 for network/SSRF failures).

WebhookSubscriptionWithSecret

object

WebhookCreate

Field	Type	Required	Description
url	string (uri)	Yes	HTTPS URL to POST deliveries to. Must be a public host.
events	array of string	Yes	Events to subscribe to. Use ["*"] for all events.
description	string \| null	No	n/a

WebhookUpdate

At least one field must be supplied.

Field	Type	Required	Description
url	string (uri)	No	n/a
events	array of string	No	n/a
enabled	boolean	No	n/a
description	string \| null	No	n/a

Get API access

API keys are created in the dashboard under Settings → API keys and require developer-access approval. Webhooks, key scopes and delivery logs are covered on the developer overview.

Request API Access Read the developer overview

Status	Description	Body
200	OK	{ ok: boolean, tenantId: string (uuid), timestamp: string (date-time) }
401	Error	Error
403	Error	Error
429	Too Many Requests	RateLimitError
500	Error	Error

API Reference

Base URL & authentication

Conventions: pagination, errors, rate limits

Cursor pagination

Errors

Rate limits

Endpoints

Meta

Responses

Contacts

Parameters

Responses

Request body (application/json, ContactCreate)

Responses

Parameters

Responses

Parameters

Request body (application/json, ContactUpdate)

Responses

Parameters

Responses

Invoices

Parameters

Responses

Parameters

Responses

Bookings

Parameters

Responses

Request body (application/json, BookingCreate)

Responses

Parameters

Responses

Parameters

Request body (application/json, BookingUpdate)

Responses

Quotes

Parameters

Responses

Request body (application/json, QuoteCreate)

Responses

Parameters

Responses

Parameters

Request body (application/json, QuoteUpdate)

Responses

Jobs

Parameters

Responses

Request body (application/json, JobCreate)

Responses

Parameters

Responses

Parameters

Request body (application/json, JobUpdate)

Responses

Webhooks

Parameters

Responses

Request body (application/json, WebhookCreate)

Responses

Parameters

Responses

Parameters

Request body (application/json, WebhookUpdate)

Responses

Parameters

Responses

Object schemas

Error

RateLimitError

Contact

ContactCreate

ContactUpdate

Invoice

Booking

BookingCreate

BookingUpdate

Quote

QuoteCreate