Skip to content

Crewcade API

The Crewcade API connects your own website or app to your club. You build the screens. Crewcade keeps the members.

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.

  1. In Crewcade, open Settings and choose Developers. Open the API keys tab. Make a key with View Members.
  2. Copy the key. It starts with cck_.
  3. Run this on your computer:
Terminal window
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/v1

People with the Manage Integrations permission make keys. Owners and admins have it by default.

  1. Open Settings and choose Developers. Open the API keys tab.
  2. Click New API key. Pick a name, the permissions and an expiry.
  3. 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.

Send the key in the Authorization header.

Terminal window
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"]
}

You pick the permissions when you make the key. You can only pick ones you have.

PermissionName in CrewcadeWhat it allows
can_view_membersView MembersRead members
can_view_sensitive_member_dataSee sensitive member dataAlso read answers to fields marked sensitive. Every read is logged.
can_view_all_eventsCan see all eventsRead events, hidden ones included. Never drafts.
can_check_in_attendeesCheck In AttendeesRead who is going to an event (together with can_view_all_events)
can_manage_webhooksManage WebhooksAdd, 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.

StatusMeaning
401The key is bad. The body is Invalid API key every time.
403The key lacks a permission. The body has code: "api_key_permission_missing" and a missingPermissions list.
404The thing you asked for does not exist in your club.
429You sent too many requests. The body says rate_limited. Wait the number of seconds in the Retry-After header.

Each key can send 60 requests per minute. Every reply to a valid key has these headers:

  • RateLimit-Limit is your limit.
  • RateLimit-Remaining is how many requests you have left.
  • RateLimit-Reset is how long until the count resets.

Ten failed key attempts in one minute block that IP address. The block lasts until the minute ends.

Method and pathPermissionPage
GET /keyAny keyThis page
GET /memberscan_view_membersMembers
GET /members/{memberId}can_view_membersMembers
GET /eventscan_view_all_eventsEvents
GET /events/{id}can_view_all_eventsEvents
GET /events/{id}/registrationscan_view_all_events, can_check_in_attendeesEvents
GET /events and GET /events/{id}Member token, no extra scopeEvents
GET /me/registrationsMember token with registrationsRegistrations
GET, POST, DELETE /events/{id}/registrationMember token with registrationsRegistrations
GET /events/{id}/peopleMember token with peoplePeople to meet
GET /meMember tokenMe and workspace
GET /workspaceAny key or member tokenMe and workspace
/webhook-endpoints and its sub-pathscan_manage_webhooksWebhooks

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.

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.

The full machine-readable spec lives here:

https://docs.crewcade.com/openapi/v1.json

It 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.