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

# Get a product

> Returns a single product, including its price, cost price, category, and stock-keeping codes.



## OpenAPI

````yaml /openapi-platform.json get /v1/platform/products/{id}
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/products/{id}:
    get:
      tags:
        - Products
      summary: Get a product
      description: >-
        Returns a single product, including its price, cost price, category, and
        stock-keeping codes.
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: The product
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformProduct'
        '400':
          $ref: '#/components/responses/PlatformBadRequest'
        '401':
          $ref: '#/components/responses/PlatformUnauthorized'
        '403':
          description: API key is missing the required `products:read` scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformError'
        '404':
          $ref: '#/components/responses/PlatformNotFound'
        '429':
          $ref: '#/components/responses/PlatformRateLimited'
      security:
        - customerApiAuth: []
components:
  schemas:
    PlatformProduct:
      type: object
      description: A product the organization sells over the counter.
      properties:
        productId:
          type: integer
        name:
          type: string
        description:
          type: string
          nullable: true
        clubId:
          type: integer
          nullable: true
          description: Club the product is sold at; null when available organization-wide.
        categoryId:
          type: integer
          nullable: true
          description: Product category it is grouped under.
        brandId:
          type: integer
          nullable: true
        sku:
          type: string
          nullable: true
          description: Stock-keeping code, if the gym uses one.
        barcode:
          type: string
          nullable: true
          description: >-
            Scanned at the till. Unique across everything scannable in the
            organization.
        price:
          type: number
          description: What a customer pays, in the organization currency.
        costPrice:
          type: number
          nullable: true
          description: >-
            What the gym pays for it; null when not tracked. Never shown to
            customers.
        isActive:
          type: boolean
          description: False for a product taken off the till without deleting its history.
        visibility:
          type: string
          enum:
            - Public
            - Member_only
            - Private
          description: Who may see it on customer-facing surfaces.
        images:
          type: array
          items:
            type: string
        features:
          type: array
          items:
            type: string
        taxRateId:
          type: integer
          nullable: true
          description: >-
            Per-product VAT rate; takes precedence over the revenue account
            default at the till.
        revenueAccountId:
          type: integer
          nullable: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    PlatformError:
      type: object
      properties:
        error:
          type: string
  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'
    PlatformNotFound:
      description: The requested resource does not exist in this organization
      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.

````