Base URL
Your base URL is provisioned during partner onboarding and is specific to your environment.{base_url} with the URL provided by your NowBookIt partner manager. All endpoint paths in this documentation are relative to this base URL.
Authentication methods
NowBookIt IPOS supports two authentication methods depending on the integration pattern you are using.- X-API-KEY (REST API)
- HMAC Signature (Partner Inbound)
All standard REST API endpoints authenticate using an How to obtain your API key:Contact your NowBookIt partner manager at partners@nowbookit.com. API keys are issued per partner per environment and are scoped to the venues linked to your app.
X-API-KEY header.Rate limiting
The API enforces rate limits per endpoint. When you exceed the limit, you will receive a429 Too Many Requests response.
Response body (429):
Error responses
All endpoints use standard HTTP status codes. Error responses follow a consistent JSON structure.Status codes
| Code | Meaning | Common causes |
|---|---|---|
200 | OK | Request succeeded |
201 | Created | Resource created successfully |
400 | Bad Request | Missing required fields, invalid date format, venue not linked to your app |
401 | Unauthorized | Missing or invalid X-API-KEY |
404 | Not Found | Resource with the given ID does not exist |
409 | Conflict | Duplicate ID within the deduplication window (e.g., sale already submitted) |
429 | Too Many Requests | Rate limit exceeded |
500 | Internal Server Error | Unexpected server error |
400 Bad Request — common messages
Venue not linked
Venue not linked
loggedInAppId error
loggedInAppId error
X-API-KEY header.Missing required fields
Missing required fields
Date filter validation
Date filter validation
When filtering bookings by date, you must provide either
StartDate + EndDate or UpdatedFromDate + UpdatedToDate. Mixing date types or omitting both will return no results without an error — check the GET /Bookings docs for details.401 Unauthorized
X-API-KEY header is missing or the key is invalid. Ensure the header is present on every request.
Content type
For allPOST, PUT, and PATCH requests, include the Content-Type header:
Environments
NowBookIt IPOS operates in separate environments. Your partner manager will confirm which base URL to use for development vs. production.| Environment | Notes |
|---|---|
| Development | Safe for testing — use the .dev. subdomain URL provided during onboarding |
| Production | Live venue data — use with care |
The Swagger specification for the development environment is available at:
https://ipos.dev.nowbookit.com/swagger/v1/swagger.json