Skip to main content
The 1Club Platform API lets you programmatically access and manage your organization’s data - clubs, classes, content, and transactions - from your own websites, integrations, and back-office scripts.

​
Base URL

All API requests are made to:

​
Official API contract

This documentation is the official source of truth for the 1Club Platform API. If an integration relies on undocumented endpoints, fields, response shapes, or internal behavior outside this spec, we can’t guarantee backward compatibility. Build against what’s documented here to stay stable as the platform evolves.

​
Authentication

All requests require a customer API key passed as a Bearer token:
The key is tied to your organization, and all responses are scoped to your organization’s data.

​
Creating an API token

API tokens are created from the admin dashboard at admin.1club.ai.
  1. Sign in to the admin dashboard
  2. Open Settings > Organization > APIs & webhooks
  3. Click Create Token
  4. Fill in the token details:
    • Name - a label to identify where this token is used (e.g. “Website Integration”)
    • Description - optional note on what the token is used for
    • Scopes - pick the resources the token can access, and whether each is Read or Write
    • Expires - set an expiry date, or leave empty for a token that never expires
  5. Click Save
  6. Copy the token immediately - it is shown only once and cannot be retrieved later
Creating and revoking API tokens requires the settings.manage.organization permission. Admins and users with full settings management can access this page; managers and other roles cannot.
For the full guide - including scope selection, expiry options, revocation, and security best practices - see the API Tokens page.

​
Token scopes

Each token is granted access to specific resources with either Read or Write permission:
  • Read - allows fetching data (GET requests)
  • Write - allows creating and updating data (POST/PUT/PATCH requests)
Grant only the scopes the integration actually needs. The Platform API currently supports these scopes:
  • classes:read - list and read classes
  • content:read - list and read published content
  • clubs:read - look up clubs by slug
  • transactions:read - list and read billing transactions
  • areas:read - list areas and read their availability
  • bookings:read - read a booking by external id
  • bookings:write - create and cancel bookings
To sync bookings from a partner booking platform, see Channel integration.

​
Revoking a token

If a token is leaked or no longer needed, revoke it from Settings > Organization > APIs & webhooks. Revocation is immediate - any integration using that token will stop working on its next request.

​
Quick start

Fetch the list of clubs:
List recent paid transactions (the last 24 hours by default):
Browse class schedules:

​
Rate limiting

  • 100 requests per minute per organization
  • When exceeded, the API returns 429 Too Many Requests with a Retry-After header
  • Rate limit headers are included in every response:
    • X-RateLimit-Limit - max requests per window
    • X-RateLimit-Remaining - requests remaining
    • X-RateLimit-Reset - seconds until the window resets

​
Errors

​
Security best practices

  • Never commit tokens to source control. Store them in environment variables or a secrets manager.
  • Use the minimum required scopes. Don’t grant write access if only read is needed.
  • Set an expiry on tokens used for short-term scripts or testing.
  • Rotate tokens regularly and revoke any that are no longer in use.
  • Never share tokens in emails, chat messages, or public channels.

​
Using this API from an AI assistant

The same Platform API is exposed over the Model Context Protocol at https://mcp.1club.ai/admin. The normal way to connect a remote MCP client is 1Club OAuth: you sign in on 1Club’s authorization page and nothing is pasted into the assistant. An API key created above is still accepted on the same endpoint when the client sends it as Authorization: Bearer 1club_sk_live_..., which is how developer-managed clients that cannot complete an interactive sign-in connect. The MCP tools are thin wrappers over these endpoints, with the same scopes, rate limits, and error shapes. See Connect an assistant. See the MCP overview for the two servers 1Club runs, and Connect an assistant for setup.

​
Need help?

Contact us at support@1club.ai for API access questions or integration support.