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

# List memberships

> Returns the organization's memberships, most recently started first. Filter by customer, plan, or status to find the one you need.




## OpenAPI

````yaml /openapi-platform.json get /v1/platform/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.


    ## 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 |
  contact:
    name: 1club API Support
    email: support@1club.ai
servers:
  - url: https://api.1club.ai
    description: Production API
security:
  - customerApiAuth: []
tags: []
paths:
  /v1/platform/memberships:
    get:
      tags:
        - Memberships
      summary: List memberships
      description: >
        Returns the organization's memberships, most recently started first.
        Filter by customer, plan, or status to find the one you need.
      parameters:
        - in: query
          name: contactId
          schema:
            type: integer
          description: Only memberships belonging to this customer
        - in: query
          name: planId
          schema:
            type: integer
          description: Only memberships on this plan
        - in: query
          name: status
          schema:
            type: string
            enum:
              - pending
              - active
              - expired
              - cancelled
              - used
              - paused
              - pending_payment
          description: Only memberships with this status
        - in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
        - in: query
          name: offset
          schema:
            type: integer
            minimum: 0
            default: 0
      responses:
        '200':
          description: Page of memberships
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformMembershipPage'
        '400':
          $ref: '#/components/responses/PlatformBadRequest'
        '401':
          $ref: '#/components/responses/PlatformUnauthorized'
        '403':
          description: API key is missing the required `memberships:read` scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformError'
        '429':
          $ref: '#/components/responses/PlatformRateLimited'
      security:
        - customerApiAuth: []
components:
  schemas:
    PlatformMembershipPage:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PlatformMembership'
        total:
          type: integer
          description: Total memberships matching the filters, ignoring pagination
        limit:
          type: integer
        offset:
          type: integer
    PlatformError:
      type: object
      properties:
        error:
          type: string
    PlatformMembership:
      type: object
      description: >-
        A customer's membership on a plan. The plan is snapshotted onto it at
        creation, so allowance and coverage behave exactly as they do for a
        membership sold in 1club.
      properties:
        membershipId:
          type: integer
        membershipUuid:
          type: string
          format: uuid
          description: >-
            Stable unguessable identifier. Prefer this over `membershipId` when
            storing a reference.
        contactId:
          type: integer
          description: Customer the membership belongs to
        planId:
          type: integer
        planName:
          type: string
          nullable: true
        clubId:
          type: integer
          nullable: true
          description: >-
            Club the membership is limited to; null when it applies
            organization-wide.
        status:
          type: string
          description: >-
            active, paused, cancelled, expired, used, pending, or
            pending_payment
        startDate:
          type: string
          format: date-time
        endDate:
          type: string
          format: date-time
          nullable: true
        renewalDate:
          type: string
          format: date-time
          nullable: true
        autoRenew:
          type: boolean
        price:
          type: number
          nullable: true
        billingFrequency:
          type: string
        maxUses:
          type: number
          nullable: true
          description: Session allowance snapshotted from the plan; null when unlimited.
        usesRemaining:
          type: number
          nullable: true
        createdAt:
          type: string
          format: date-time
  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.

````