Crewcade API
The Crewcade API connects your own website or app to your club. You build the screens. Crewcade keeps the members.
What you can do today
Section titled “What you can do today”Your server reads your club’s members and events. It uses a key that you make in Crewcade. Your own website or app can also let members sign in with their Crewcade account. After a member signs in, your app reads their name, photo and email. The member allows this first. Your app can also read the events that member can see. With more permissions, your app can sign the member up for free events. It can also show the people going to an event. See Sign in with Crewcade and Connected apps.
Your server can also get a message when something changes in your club. This is a webhook. See Webhooks.
Quick start
Section titled “Quick start”- In Crewcade, open Settings and choose Developers. Open the API keys tab. Make a key with View Members.
- Copy the key. It starts with
cck_. - Run this on your computer:
curl https://api.crewcade.com/api/v1/members \ -H "Authorization: Bearer cck_your_key_here"You get the first 20 members of your club.
All requests go to this base URL:
https://api.crewcade.com/api/v1Get a key
Section titled “Get a key”People with the Manage Integrations permission make keys. Owners and admins have it by default.
- Open Settings and choose Developers. Open the API keys tab.
- Click New API key. Pick a name, the permissions and an expiry.
- Copy the key. It starts with
cck_.
Crewcade shows the key once. Store it somewhere safe. If you lose it, revoke it and make a new one. The club owner gets an email each time someone makes a key.
Keep keys on your server. A key inside a web page or a phone app is public. Anyone who finds it can use it.
Authenticate
Section titled “Authenticate”Send the key in the Authorization header.
curl https://api.crewcade.com/api/v1/key \ -H "Authorization: Bearer cck_your_key_here"The reply shows what this key can do.
{ "keyId": "key_123", "workspaceId": "k3m9x2pq4r7t", "permissions": ["can_view_members"]}Permissions
Section titled “Permissions”You pick the permissions when you make the key. You can only pick ones you have.
| Permission | Name in Crewcade | What it allows |
|---|---|---|
can_view_members | View Members | Read members |
can_view_sensitive_member_data | See sensitive member data | Also read answers to fields marked sensitive. Every read is logged. |
can_view_all_events | Can see all events | Read events, hidden ones included. Never drafts. |
can_check_in_attendees | Check In Attendees | Read who is going to an event (together with can_view_all_events) |
can_manage_webhooks | Manage Webhooks | Add, change and delete webhook endpoints |
New permissions arrive with the endpoints that need them.
A key can never do more than the person who made it. It stops working when:
- that person loses a permission, loses Manage Integrations, or leaves the club.
- the key expires.
- someone revokes the key.
Expiry is 30 days, 90 days, 1 year or never. The default is 1 year.
Errors
Section titled “Errors”| Status | Meaning |
|---|---|
| 401 | The key is bad. The body is Invalid API key every time. |
| 403 | The key lacks a permission. The body has code: "api_key_permission_missing" and a missingPermissions list. |
| 404 | The thing you asked for does not exist in your club. |
| 429 | You sent too many requests. The body says rate_limited. Wait the number of seconds in the Retry-After header. |
Rate limits
Section titled “Rate limits”Each key can send 60 requests per minute. Every reply to a valid key has these headers:
RateLimit-Limitis your limit.RateLimit-Remainingis how many requests you have left.RateLimit-Resetis how long until the count resets.
Ten failed key attempts in one minute block that IP address. The block lasts until the minute ends.
Endpoints
Section titled “Endpoints”| Method and path | Permission | Page |
|---|---|---|
GET /key | Any key | This page |
GET /members | can_view_members | Members |
GET /members/{memberId} | can_view_members | Members |
GET /events | can_view_all_events | Events |
GET /events/{id} | can_view_all_events | Events |
GET /events/{id}/registrations | can_view_all_events, can_check_in_attendees | Events |
GET /events and GET /events/{id} | Member token, no extra scope | Events |
GET /me/registrations | Member token with registrations | Registrations |
GET, POST, DELETE /events/{id}/registration | Member token with registrations | Registrations |
GET /events/{id}/people | Member token with people | People to meet |
GET /me | Member token | Me and workspace |
GET /workspace | Any key or member token | Me and workspace |
/webhook-endpoints and its sub-paths | can_manage_webhooks | Webhooks |
GET /me and GET /workspace also work with a member token from Sign in with Crewcade. The members endpoints and GET /events/{id}/registrations need an API key. The events endpoints also work with any member token.
Language
Section titled “Language”Add ?locale=ja to any /v1 request to pick a language. You can also send an Accept-Language header. The locale query wins if you send both. See Me and workspace.
OpenAPI spec
Section titled “OpenAPI spec”The full machine-readable spec lives here:
https://docs.crewcade.com/openapi/v1.jsonIt is OpenAPI 3.0, built from the API code. It lists every endpoint, field and error above. Use it to:
- try each call in Postman, Insomnia or Bruno.
- generate a typed client for your language with a tool like OpenAPI Generator.
- give an AI coding tool the exact shape of each reply.