Quick Facts
- Base URL
- https://shoalevents.com/api/v1
- Sign In
- A Bearer API key, created by an owner or admin on the API page
- Rate Limit
- 300 requests a minute per key
The OpenAPI file loads straight into Postman or Insomnia, so every request is ready to try.
Download the OpenAPI FileGuides and Reference
Full Reference
API reference
Every API address and field, for reading and updating your events, agenda, audiences, sponsors, notifications and attendees.
Read More
Start here: what the API is
A plain-English introduction to the API, with the few words you need to know before connecting a tool.
Read More
Create a key and find your event id
Make an API key, keep it safe, and find the id of the event you want to connect.
Read More
Try the API in two minutes
Check your key works by listing your events and adding one test person, straight from your computer.
Read More
Connect Google Sheets
Add a Shoal menu to a Google Sheet that sends your list of people to an event and brings registrations back.
Read More
Connect Zapier or Make
Add each new form response, purchase or signup from another tool to your event automatically.
Read More
Connect Airtable
Send an Airtable table of people to your event with an automation script.
Read More
Fix API errors
What each API error means and how to fix it.
Read More
Webhooks
Have Shoal tell another tool the moment someone registers, cancels or checks in.
Read More
Plan Your Next Event on Shoal
Your first 2 events of up to 50 people are free if you create them before January 1, 2027. Set up in an afternoon.