Venue routes¶
These are our older routes, under /partners/. Many integrations use them, and we keep them working. They are the way to sync guests,
orders and reservations today. For everything else, prefer the API routes.
How they differ from the API routes¶
- One key, one venue. A venue key reads one venue. A group with ten venues holds ten keys.
- Full records. Most answers are our stored records, with all their columns. The pages here list the fields you should use. Other columns can appear, and new ones can be added at any time. Do not rely on them. Some are internal, and some can change without notice.
- No paging on the sync routes. See Keep your data in sync.
- A bad key gets a
400, not a401. See Errors. - No field groups or per-route permissions. A venue key reads everything on these routes for its venue.
- Plain JSON. You do not need any special header.
All the routes¶
With a venue key¶
| Route | What it does | Page |
|---|---|---|
GET /partners/events |
The venue's events | Events |
GET /partners/events/statistics |
Sales numbers for upcoming events | Events |
POST /partners/event/:eventId/update-webflow-cms-id |
Store your Webflow item id on an event | Events |
GET /partners/sync/users |
Guests | Guests |
GET /partners/sync/bookings |
Orders | Orders |
GET /partners/sync/reservations |
Table reservations and requests | Reservations |
GET /partners/sync/booking-refunds |
Refunds on orders | Refunds and disputes |
GET /partners/sync/booking-disputes |
Disputes on orders | Refunds and disputes |
GET /partners/sync/paylink-refunds |
Refunds on paylinks | Refunds and disputes |
GET /partners/sync/paylink-disputes |
Disputes on paylinks | Refunds and disputes |
GET /partners/sync/table-booking-refunds |
Refunds on online table payments | Refunds and disputes |
GET /partners/sync/table-booking-disputes |
Disputes on online table payments | Refunds and disputes |
GET /partners/sync/venue-users |
The venue's team | Team members |
With an event publisher key¶
| Route | What it does | Page |
|---|---|---|
GET /partners/events/all |
Events across the venues that share with you | Event publisher feeds |
GET /partners/events/spotify |
A feed in one partner's format | Event publisher feeds |
GET /partners/events/jambase |
A feed in one partner's format | Event publisher feeds |
The sync parameter¶
Every /partners/sync/ route needs lastSyncedAt, in exactly this format, in UTC:
It cannot be more than 15 days old, except on venue-users. Every sync answer has the same two extra fields:
| Field | Meaning |
|---|---|
syncedAt |
The time we started this answer. Send it as lastSyncedAt next time. |
meta |
venueId, and newCount and updatedCount (or count on bookings) |