The ShowSculptor API lets developers connect your studio to your own website or tools. API keys are available on Essentials and Production Pro, and stop working if you move to Free. Webhooks work on every plan.
Get started
Go to Settings, then Integrations, and create a key under API Keys & Zapier. Copy it right away. It's only shown once.
Click View API documentation for every endpoint, with examples.
Send the key with each request in the header Authorization: Bearer followed by your key.
The API base URL is https://app.showsculptor.com/api/public/v1. Requests and responses use JSON.
What you can do
Read, create, update and delete dancers, families, shows and routines.
Add or remove dancers on a routine, and see a show's routines.
Read and add volunteers.
Read volunteer signups, check-ins, signed waivers and costume orders, and update a costume order's status.
Lists return up to 100 records at a time, newest first. Your plan's limits apply, so creating records past your plan's limit returns an error.
Webhooks
Webhooks send a message to your server the moment something happens.
Under Webhooks, choose an Event.
Enter your Endpoint URL and click Add.
Click Secret to copy the signing secret for that webhook.
Each webhook is a POST with the event, your studio ID, when it happened and the data. Check the X-ShowSculptor-Signature header (an HMAC-SHA256 of the body using your secret) to make sure it came from ShowSculptor. Deliveries arrive within about a minute and are retried if your server doesn't respond.
Good to know: An API key gives full access to your studio's data. Keep it private, and delete keys you no longer use.