API keys

Let another system read your PreOrders, guests, payments and hosts, and change a PreOrder's notes, message for guests, maximum guests and times. It is in Settings, on the API page, and only Admins can see it. Each key has its own name, venue, permissions and end date, and you can stop one at any time.

To make a key

  1. Step 1: Open Settings and click API.
  2. Step 2: Give the key a name (the system that will use it), choose one venue or all venues, tick what it may do and choose when it ends.
  3. Step 3: Click Create key and enter the emailed code if asked.
  4. Step 4: Copy the key straight away. It is shown once, and PreOrderly keeps only a scrambled copy that cannot be turned back into the key.

To stop a key

  1. Step 1: Find it under Your keys.
  2. Step 2: Click Revoke and confirm. It stops working at once.
  3. Step 3: Make a new key for the system if it still needs access.

To see what a key did

  1. Step 1: Scroll to Recent activity.
  2. Step 2: Each row shows the time, the key, what was asked and the answer.
  3. Step 3: Rows that included guests' allergy data say how many guests it covered.

What things mean

Read PreOrders
Names, dates, times, status, guest counts and money totals.
Read guests
Guest names, email and replies. Nothing about food or allergies.
Read dietary and allergy data
Each guest's dietary menu and allergies. Needs your confirmation and is logged.

Tips

  • Give a key only the permissions it needs. Reading guests never includes food or allergies: that is a separate permission, and you must confirm there is a lawful reason to share allergy data before a key can have it.
  • Allergy data is special category data. Every time a key reads it, the guests it covered are written to the activity list.
  • A key limited to one venue can never see another venue. A key for all venues also covers venues you add later.
  • A key stops working if your subscription is not live. Reading and changing then resume once it is.
  • The page also has the full guide with examples, and a machine readable description at /api/v1/openapi.json.

Still need help?

Email us with what you were doing and what you saw. A person replies within one working day. Guests and hosts: for questions about a booking, please contact the venue first.

Contact supportsupport@preorderly.app

Something not loading? Check the system status.

API keys · PreOrderly