API v2 - Overview & authentication

You can access various data from Locaboo, available in JSON format. This reference gives an overview of how to access the API and what data is available.

TIP

Endpoints not listed in this reference are internal and unsupported.

API authentication and access

In order to access the APIs, please use the 'API Access Data' available from the 'Profile' section of your Locaboo manager dashboard.

Every API call requires the parameter api_secret_key:

• For GET requests, pass it as a query-string parameter.
• For POST requests with a body (JSON or form-encoded), include api_secret_key inside the body - a query-string key is not read when a request body is present.

Calls are rate-limited per key (a short per-request cooldown plus a daily quota); exceeding either returns HTTP 429.

API endpoints

Endpoint base URL:

https://app.locaboo.com

The API returns HTTP status 200 only for successful API calls.

Response envelope

Every endpoint wraps its payload in a common JSON envelope:

{
  "data": [],
  "total": 0,
  "success": true
}

• data - the payload; an object or array depending on the endpoint, or a plain error message string when success is false.
• total - the number of records covered by the call (some write endpoints return 0 or omit it).
• success - true only when the call succeeded.

Invoice List additionally echoes limit and offset in the envelope.

Endpoint index

Endpoint	Description
GET /api/v2/resource_list	List of resources along with the fields available for each resource
GET /api/v2/resource/<resource-id>	Details of resource based on ID
POST /api/v2/resource_add	Create a new resource
GET /api/v2/booking_list	List of bookings under a manager
GET /api/v2/booking/<booking-id>	Details of booking based on ID
GET /api/v2/availability	List of available time-slots at resource
GET /api/v2/booking_save	Create/Update the bookings
POST /api/v2/booking_add	Add new booking or booking request
GET /api/v2/event_list	List of events under a manager
GET /api/v2/event_details/<event-id>	Details of event based on ID
GET /api/v2/customer_list	List of customers along with the fields available for each customer
POST /api/v2/customer_add	Add new customer
POST /api/v2/customer_edit	Edit existing customer
POST /api/v2/customer_address_add	Add customer addresses
GET /api/v2/invoice_list	List of invoices along with the fields available for each invoice
GET /api/v2/invoice_details	Detailed information for a specific invoice
GET /api/v2/inventory_list	List of inventory along with the fields available for each inventory item
GET /api/v2/service_list	List of services along with the fields available for each service
GET /api/v2/profile	Get details of a manager