API keys let a developer or another system, such as a check-in kiosk or a custom integration, connect to your Red Belt Gym data. You manage them on the API keys card on the Gym Details page.
Note: Only the gym owner can create and revoke API keys.
Create an API Key
- Visit redbeltgym.com.
- Sign in to your account.
- Click Setup in the left-side menu.
- Under Gym & account, click Gym Details.
- On the API keys card, click New key. The card lists each key's name, status, when it was created and when it was last used.
- Enter a Key name you'll recognize later, such as "Zapier", "Website booking" or "Accounting".
- Click Generate key.
- Copy the key and store it somewhere safe. Keys are shown in full only once, when they're created. After that, only the start and end of the key are shown.
Revoke a Key
Keys don't expire. Revoke a key you no longer use, or one that may have been shared by mistake. Any integration using that key stops working.
- On the API keys card, click the three dots next to the key.
- Click Revoke key.
Read the API Documentation
- Click API documentation on the API keys card.
- The documentation shows the Base URL, the x-api-key authentication header and each endpoint with its parameters and an example request.
Currently the API supports POST /external/check-in, which checks a student in to a class. Send the student's contactId and the classId in the request body. If the student isn't scheduled for that class today, Red Belt Gym schedules them into the class's current or next session automatically.