Home / Guides / NewBook API

NewBook API technical guide

For administrators and technical users connecting third-party modules to NewBook.

Overview

The NewBook API is a REST interface that allows authorised third-party applications to read and write data in a NewBook property account. Every request must be authenticated with an API key generated from the NewBook admin panel. Requests are made over HTTPS and responses are returned as JSON.

Authentication

Include your NewBook API key in the X-Api-Key header of every request. Example: X-Api-Key: <your-newbook-api-key>. Keys must be kept confidential. If compromised, revoke it from the NewBook admin panel and generate a new one immediately.

Main endpoint categories

  • Reservations: GET/POST/PATCH operations on reservation records. Includes arrival/departure, room type, rate plan, guest contact details, source channel, payment status.
  • Rates: GET to retrieve current rates; POST to push updates over specific date ranges and room types. Required for the Multi-Property Central Dashboard and Multi-Property Central Dashboard modules.
  • Guest profiles: GET the profile by reservation or by guest ID; POST to update profiles. Required for the Guest Registration & Digital Waivers and Guest CRM modules.
  • Channels: GET to list connected channels and their status. Read only; channel connections are managed inside the NewBook channel manager interface.
  • Reports: GET night audit data, the pickup report, occupancy summary. Required for the Automated Invoicing and Yield Management modules.
  • Webhooks: register a webhook URL to receive event notifications (new booking, check-out, cancellation). Required for the Guest CRM module.

Rate limiting

NewBook enforces a per-API-key rate limit. Exceeding it returns HTTP 429. Implement exponential back-off: wait 1s on the first 429, 2s on the second, 4s on the third, and so on. Batch requests by date range wherever possible rather than calling per night, to minimise call volume.

Error handling

HTTP statusMeaningAction
200/201SuccessProcess the response normally
400Invalid request — malformed payloadCheck the request structure against the API documentation
401Unauthorised — invalid API keyVerify the API key is correct and not revoked
403Forbidden — insufficient permissionsVerify the API key scopes inside NewBook
404Resource not foundVerify the reservation or rate-plan identifier
429Rate limit exceededApply exponential back-off
500/503NewBook server errorRetry after 60s; contact NewBook support if it persists

Test environment and sandbox

NewBook provides a sandbox environment for API testing on certain subscription tiers. Ask your NewBook account manager for access. CloudBookMod runs integration tests against the NewBook sandbox before every module release and after every NewBook API update notification.

Additional resources