Skip to main content

Exports

Ask for a file of the account's own data โ€” a spreadsheet or a PDF โ€” and download it from a signed, expiring link. The same pipeline backs the Downloads page in the portal and the assistant, so a file requested through the API is identical to one requested in the app.

Authenticationโ€‹

Requires an API key with the reports:read scope.

What can be exportedโ€‹

DatasetCovers
bookingsBookings, with customer, dates, total and payment state
customersThe customer list
experiencesExperiences and their setup
experience_sessionsIndividual sessions with capacity, bookings and guides
productsRental items
store_productsShop items
inventoryRental stock, per item and location
bundlesCombos
extrasAdd-ons
promo_codesPromo codes and how often each was used
vouchersGift cards and their remaining value
waiver_responsesSigned forms
staffThe team
staff_shiftsRosters
timesheetsHours worked
paymentsPayments taken
campaignsMarketing sends
programsPrograms
groupsSaved groups
myobSales, payments, customers, refunds and (when switched on) card fees and Stripe payouts, as the files MYOB AccountRight imports. Needs the bookings:read scope

Formatsโ€‹

  • csv โ€” opens anywhere, written with a UTF-8 byte-order mark so accented names survive Excel.
  • xlsx โ€” a real workbook: money and counts are numeric cells, so a column can be sorted and totalled. The header row is frozen.
  • pdf โ€” a branded landscape table for printing or sending on, with the business name, the dates covered and page numbers.
  • myob - only for the myob dataset, which takes no other format. A zip of tab-delimited files, numbered in the order MYOB imports them: customer cards, service sales, receive payments, spend money and general journal entries. Account numbers and tax codes come from the business's MYOB settings. Each download is remembered, so the next one can start the day after.

Limitsโ€‹

These exist so a single request cannot ask for an unbounded amount of work. A request over a limit is refused with an explanation โ€” it is never silently truncated into a file that looks complete.

LimitValue
Rows in one filePer dataset, up to 25,000
Rows in a PDF2,000 (use a spreadsheet above that)
Default date windowLast 12 months, when a dataset has dates and the request gives none
Exports started12 per account per hour
Exports building at once2 per account
File kept for7 days, then the file is deleted (the record remains)

Permissionsโ€‹

The caller needs the export permission and the permission to see that dataset โ€” a key that can read bookings but not customers cannot export customers. Both are checked when the export is requested and again when the file is built.

A download link is signed and expires after 24 hours. It also requires a signed-in team member of the account that owns the file, so a forwarded link is useless to anyone else. Once an export has passed its keep-until date the link returns 410 Gone โ€” ask for the export again and a fresh copy is made.