> ## Documentation Index > Fetch the complete documentation index at: https://docs.1club.ai/llms.txt > Use this file to discover all available pages before exploring further. # Memberships report for a period > How the organization's memberships moved over a period: how many were added and cancelled, how many were active when it began and ended, and what share of those active at the start were cancelled in it - for recurring Memberships, Passes and Drop-Ins apart (`byKind`) and together (`totals`), and for the plans that moved most (`byPlan`). `added` counts the memberships created in the period, whatever became of them since, except a checkout still waiting for its first payment - the Memberships series of the admin's Historical dashboard. `cancelled` counts the cancellations recorded in the period, immediate or at the end of the paid period; one undone since is not counted. A membership is active at a moment when it has started, is not past its end date and has not been stopped (cancelled outright, or a Pass with every entry used); a paused membership is active, one still waiting for its first payment is not. Money is not here: what memberships earned is in the revenue report's `memberships`, `passes` and `drop_ins` streams. The period is compared with the same number of days just before it or the same dates a year earlier, and `trend` buckets the additions and cancellations by day, week or month. Days are the club's own calendar days, on the organization's clock. A period may span at most 366 days. Reports have their own limit of 20 requests a minute, on top of the platform's. ## OpenAPI ````yaml /openapi-platform.json get /v1/platform/reports/memberships openapi: 3.0.0 info: title: 1club Platform API version: 1.0.0 description: >- The 1club Platform API lets you programmatically access and manage your organization's data. ## 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: ``` Authorization: Bearer 1club_sk_live_... ``` Generate API keys from the admin portal under **Settings > API Tokens**. The key is tied to your organization - all responses are scoped to your org's data. Agents and MCP connectors can instead send an OAuth access token (the `platformOAuth` scheme), requesting only the scopes the task needs. ## Rate Limiting - **100 requests per minute** per API key - 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 | Status | Meaning | |--------|---------| | `400` | Invalid request parameters | | `401` | Missing or invalid API key | | `404` | Resource not found (or doesn't belong to your organization) | | `429` | Rate limit exceeded | | `500` | Internal server error | ## Versioning and deprecation The API is versioned in the path (`/v1`). Changes within a version are additive: new endpoints, new optional parameters and new response fields can appear at any time, so clients should ignore fields they do not recognise. A breaking change ships as a new version. An operation due to be removed is first marked `deprecated: true` in this spec and announced in the changelog at https://docs.1club.ai/changelog, with advance notice before it is withdrawn. contact: name: 1club API Support email: support@1club.ai servers: - url: https://api.1club.ai description: Production API security: - customerApiAuth: [] - platformOAuth: [] tags: [] paths: /v1/platform/reports/memberships: get: tags: - Reports summary: Memberships report for a period description: > How the organization's memberships moved over a period: how many were added and cancelled, how many were active when it began and ended, and what share of those active at the start were cancelled in it - for recurring Memberships, Passes and Drop-Ins apart (`byKind`) and together (`totals`), and for the plans that moved most (`byPlan`). `added` counts the memberships created in the period, whatever became of them since, except a checkout still waiting for its first payment - the Memberships series of the admin's Historical dashboard. `cancelled` counts the cancellations recorded in the period, immediate or at the end of the paid period; one undone since is not counted. A membership is active at a moment when it has started, is not past its end date and has not been stopped (cancelled outright, or a Pass with every entry used); a paused membership is active, one still waiting for its first payment is not. Money is not here: what memberships earned is in the revenue report's `memberships`, `passes` and `drop_ins` streams. The period is compared with the same number of days just before it or the same dates a year earlier, and `trend` buckets the additions and cancellations by day, week or month. Days are the club's own calendar days, on the organization's clock. A period may span at most 366 days. Reports have their own limit of 20 requests a minute, on top of the platform's. operationId: getMembershipsReport parameters: - in: query name: from required: true schema: type: string format: date description: >- First day of the period (`YYYY-MM-DD`), on the organization's own clock. - in: query name: to required: true schema: type: string format: date description: Last day of the period, inclusive. - in: query name: clubId schema: type: integer description: Only the memberships sold for this club. - in: query name: compare schema: type: string enum: - previous_period - previous_year - none default: previous_period description: What to compare the period with. - in: query name: granularity schema: type: string enum: - day - week - month description: >- How `trend` buckets the period. Chosen from the period's length when omitted. - in: query name: topPlans schema: type: integer minimum: 1 maximum: 50 default: 10 description: How many plans `byPlan` lists. responses: '200': description: The report content: application/json: schema: $ref: '#/components/schemas/PlatformMembershipsReport' '400': $ref: '#/components/responses/PlatformBadRequest' '401': $ref: '#/components/responses/PlatformUnauthorized' '403': description: API key is missing the required `analytics:read` scope content: application/json: schema: $ref: '#/components/schemas/PlatformError' '429': $ref: '#/components/responses/PlatformRateLimited' security: - customerApiAuth: [] components: schemas: PlatformMembershipsReport: type: object properties: period: type: object properties: from: type: string format: date to: type: string format: date days: type: integer timezone: type: string description: >- The clock the days are read on: the organization's timezone, as on the admin analytics dashboards. totals: $ref: '#/components/schemas/PlatformMembershipFigures' byKind: type: array description: Memberships (recurring), Passes and Drop-Ins apart. items: allOf: - $ref: '#/components/schemas/PlatformMembershipFigures' - type: object properties: kind: type: string enum: - membership - pass - drop_in byPlan: type: array description: The plans that moved most - added plus cancelled - largest first. items: type: object properties: planId: type: integer planName: type: string kind: type: string enum: - membership - pass - drop_in added: type: integer cancelled: type: integer activeAtEnd: type: integer comparison: type: object nullable: true properties: kind: type: string enum: - previous_period - previous_year period: type: object properties: from: type: string format: date to: type: string format: date totals: $ref: '#/components/schemas/PlatformMembershipFigures' change: type: object properties: added: $ref: '#/components/schemas/PlatformReportChange' cancelled: $ref: '#/components/schemas/PlatformReportChange' activeAtEnd: $ref: '#/components/schemas/PlatformReportChange' trend: type: object properties: granularity: type: string enum: - day - week - month points: type: array items: type: object properties: start: type: string format: date added: type: integer cancelled: type: integer PlatformError: type: object properties: error: type: string code: type: string description: >- A stable, machine-readable reason, when the error has one (e.g. `CONTACT_EXISTS`). details: type: object additionalProperties: true description: >- Structured values behind the error. A 409 naming an existing record carries its id here, e.g. `contactId`. PlatformMembershipFigures: type: object properties: added: type: integer description: >- Created in the period, whatever became of them since, except a checkout still waiting for its first payment. cancelled: type: integer description: >- Cancelled in the period, immediately or at the end of the paid period. A cancellation undone since is not counted. activeAtStart: type: integer activeAtEnd: type: integer description: At the end of the period, or now when it has not ended yet. cancellationRate: type: number nullable: true description: >- Of those active at the start, the percent cancelled in the period. Null with none active. PlatformReportChange: type: object properties: amount: type: number percent: type: number nullable: true description: Null when the comparison period had none. responses: PlatformBadRequest: description: Invalid request (bad parameters, or a body that fails validation) content: application/json: schema: $ref: '#/components/schemas/PlatformError' PlatformUnauthorized: description: Invalid or missing API key content: application/json: schema: $ref: '#/components/schemas/PlatformError' PlatformRateLimited: description: Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/PlatformError' securitySchemes: customerApiAuth: type: http scheme: bearer description: >- Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token. platformOAuth: type: oauth2 description: >- OAuth 2.1 authorization code flow with PKCE (S256), as used by MCP connectors. Register a client dynamically (RFC 7591) at https://api.1club.ai/v1/mcp/oauth/register. Each scope grants one capability; request only what the integration needs. flows: authorizationCode: authorizationUrl: https://auth.1club.ai/oauth/authorize tokenUrl: https://api.1club.ai/v1/mcp/oauth/token scopes: '*': >- Full access - read and manage everything in this organization, including capabilities added later classes:read: View classes, class types, schedules and progression tracks classes:write: >- Create, reschedule, and cancel classes, and maintain the class types they are run as checkins:read: View check-ins checkins:write: Check people in, to a booking or on their membership content:read: View published content content:write: >- Create, edit and delete content - posts, FAQs, documents and reusable blocks website:read: >- View your website: pages, sections, layout, styles and publish history website:write: >- Edit your website - pages, sections, navigation and styles. Edits stay unpublished until published. website:publish: >- Publish your website, making unpublished edits visible to the public, and roll back to an earlier version media:read: View your media library media:write: >- Add images and videos to your media library and edit their names and descriptions media:delete: Permanently delete files from your media library clubs:read: View club information clubs:write: >- Edit your clubs' details - name, contact details, address, opening hours, amenities and sports. Live on your website, member portal, app and 1club.me at once; a club listed on 1club.me sends its listing's changes for review. transactions:read: View transactions, revenue reports and your chart of accounts transactions:write: >- Record revenue collected outside 1club, such as a marketplace payout for your bookings, and refunds of it. Nothing is charged to anyone. invoices:read: >- View your invoices - who they were issued to, their amounts and status - and how much was invoiced over a period areas:read: View areas, area types, blocks and availability areas:write: >- Create and update areas and area types, and block or unblock an area bookings:read: View bookings bookings:write: >- Create, change, reschedule and cancel bookings, and add or remove participants contacts:read: >- View contacts, their tags and custom field values, and your sales pipeline stages and sources contacts:write: >- Create and update contacts and tag them, and maintain your tags, smart tag rules and contact custom fields contacts:delete: >- Archive contacts, which cancels their active memberships and all their future bookings. Separate from creating and updating because those cancellations are not undone by restoring the contact. instructors:read: View instructors and their availability instructors:write: >- Create and update instructors (coaches) and the instructor types they are grouped by, including what members pay for a one-to-one session and how you pay the coach. Does not grant admin-portal access: an instructor created this way has no login and is never invited to your staff portal. plans:read: View plans and pricing plans:write: Create, edit and delete plans and plan categories memberships:read: View memberships memberships:write: >- Sell memberships, set their price and whether they are paid, and pause, resume or cancel them products:read: >- View the product catalogue and its categories, including prices and how many are left to sell products:write: Create and edit products and product categories forms:read: >- View your forms and their questions, and how many people have completed each. Not the answers themselves. forms:write: >- Create and edit forms and their questions, including sign-up forms that sell your plans and products. Forms are public as soon as they are created or changed. Does not delete forms. organization:write: >- Change organization-wide settings, which take effect immediately. That includes which languages you offer, across your website, the member portal, the mobile app and email, and what your clubs call their booking cards (private training, group activities, areas) wherever members book. revenue-accounts:write: >- Add accounts to your chart of accounts and edit them, including which one sales post to by default. Reading the chart needs no scope of its own - any of plans, products or transactions admits it. pricing-rules:read: >- View pricing rules - the surcharges, discounts and set prices applied when a booking is priced - and quote what a booking would cost pricing-rules:write: >- Create, edit, turn off and delete pricing rules. Changes apply to every booking priced afterwards. booking-policies:read: >- View booking policies: cancellation and refund rules, payment timing and booking windows booking-policies:write: >- Create, edit, duplicate and delete booking policies. Changes apply to every booking they cover from then on. document-rules:read: >- View document rules - which members are asked to sign or accept which documents, such as waivers document-rules:write: >- Create, edit and delete document rules, which decide who must sign or accept a document and whether it is required for entry templates:read: View your email and SMS templates templates:write: Create, edit and delete email and SMS templates events:read: View events, their tickets and how many are sold events:write: >- Create, edit, duplicate and delete events, and publish, unpublish or cancel them. Cancelling an event also cancels its attendees' bookings. messages:read: >- View messages sent to and received from your members, and their delivery status messages:write: >- Prepare draft messages to members. Drafts are never sent from here: someone at your club reviews and sends them from 1club. analytics:read: >- View statistics over a period - revenue, bookings, check-ins, how full your classes, courts and coaches were, memberships added and cancelled, and new members - as totals, never the people or sales behind them payment-methods:write: >- Add, rename and remove the payment methods staff record by hand, such as cash or a bank transfer, and choose which ones members may pick when paying for a booking. Reading them needs no scope of its own - transactions:read admits it. staff:read: >- View your staff accounts, their roles, and what each role is allowed to do staff:write: >- Change a staff member's role, and what the manager, front desk and instructor roles are allowed to do. Only a signed-in person can use it, with the same limits as in 1club: an API key is always refused. notifications:read: >- View which notifications each role gets by default, and on which channels notifications:write: >- Change which notifications each role gets and on which channels, and apply those defaults to everyone in a role, replacing their own choices ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.