Who this is for: members who connect Zapier, and developers building their own tools on Boathouse Connect data. Permission required: none — every member can manage their own keys under Basic Access.
An API key lets software outside Boathouse Connect act on your behalf. Keys belong to you, not to your organization: anything done with a key is done as you, with the permissions your groups give you, and only in organizations you are a member of. There is no organization-level key or shared club login.
You need a key to connect Zapier or to call the Boathouse Connect API from your own code. The API reference itself is at /home/apilanding.
See your keys
Go to My Profile → API Keys. The page lists every key on your account with its description and the date it was created. Each one is labeled by type:
| Label | Where it comes from |
|---|---|
| General API token | A key you created for your own software. |
| Zapier token | A key you created for the Zapier integration. |
| iOS app token / Android app token | Created when you sign in to the mobile app on a phone. |
| Singe-Sign-On Token (sic, as shown on the page) | Created by Boathouse Connect when it signs you in to a connected service. |
Click any key to open its details: Token, Type, Description, Created At, Last Used and Expires.
Create a key
- Go to My Profile → API Keys.
- Click the green + button.
- Choose a Token Type:
- General API Token — for your own scripts and applications.
- Zapier-Only Token — for connecting Zapier.
- Enter a Description that says what the key is for, such as Results spreadsheet script.
- Click Save. The page reloads with the new key in the list.
Use one key per integration. If one is ever exposed or no longer needed, you can delete it without breaking the others.
Renew a key
Keys expire one year after they are created. To keep one working:
- Open the key from My Profile → API Keys.
- Click Reset Expiration Date.
The key's Expires date moves to one year from today. The key itself does not change, so nothing needs to be updated in the software using it.
Delete a key
- Open the key from My Profile → API Keys.
- Click Delete Token.
The key stops working immediately and the deletion cannot be undone. If you delete an iOS app token or Android app token, expect that phone to need signing in again.
Keep your keys safe
- Treat a key like your password. Anyone who has it can do what you can do in Boathouse Connect.
- Do not paste keys into shared documents, chat or public code repositories.
- Delete keys you no longer use, and check Last Used for anything unexpected.
- If you lose a permission because you left a group, keys lose it too.
Where the API reference lives
The full API reference — introduction, authentication, and each area of the product (organizations, users, groups, practices and regattas, equipment, communications, finances, surveys and Zapier) — is at /home/apilanding. It is written for developers and is kept separate from these guides.
FAQ
Can our club have one shared API key? No. Keys always belong to a person. If an integration should keep working when someone leaves the club, create it with the key of a person who will stay in the relevant group, and move it to a new key when responsibilities change.
Why can my key read some data but not other data? A key has exactly your permissions. If a request needs, for example, Manage Finances, you must be in a group that grants it in that organization. See Roles & permissions.
I belong to two clubs. Does one key work for both? Yes. The key works in every organization you are a member of; the organization is chosen per request.
Can I change a key's description or type? Not after it is created. Create a new key with the right type and description, switch your integration to it, then delete the old one.