Only the organization's owners and admins can create keys (Check-in only members and Shoal support can't see them). Each key works for every event in your organization.
Create a key
- In the left menu, under Organization, choose API.
- Choose Add API Key, then type a Key Name that says where it will be used, such as Google Sheets or Zapier.
- Choose Add API Key in the pop-up. (You can have up to 20 active keys.)
- Copy the key with the copy icon and paste it somewhere safe, like your password manager. Shoal only shows it once.
Keep your key safe
- Anyone with the key can read and change your attendee lists, so treat it like a password.
- Only paste it into tools you trust, and never into an email, chat message or shared document.
- If you put it in a spreadsheet script, everyone who can edit that spreadsheet can see it. Share the spreadsheet only with people who could see your attendees anyway.
- Lost it? You can't see a key again. Create a new one and delete the old one.
Find your event id
- Open the event in Shoal (choose it on the Events screen).
- Look at your browser's address bar. It shows something like shoalevents.com/dashboard/events/3f2b9c1e-7a4d-4b8e-9f10-2c6d5e8a1b23.
- The event id is the long code after /events/, up to the next slash if there is one. Copy just that part.
Each event has its own id, so a tool that should work with two events needs both ids. You can also list every event and its id with a GET request to /events (see the next guide).