> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fitsociety.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get client workout equipment catalog, selections, and presets

> Requires the workout_client_plans:read scope. This operation maps to /app/v1/workout/equipment/clients/:clientId and retains its Workout V2 permission, feature-flag, and resource-scope checks.

The clientId path parameter is resolved inside the company bound to the Public API token when present.



## OpenAPI

````yaml /openapi/public-v1.json get /public/v1/workout/equipment/clients/{clientId}
openapi: 3.1.0
info:
  title: FITsociety Public API v1
  version: 1.0.0
  description: >-
    Developer Public API endpoints under `/public/v1`. This reference is
    filtered to OAuth/Bearer Public API resources and excludes provider callback
    receivers, storefront routes, public widgets, wishlist routes, and
    access-device validation endpoints.
  contact:
    name: FITsociety Engineering
servers:
  - url: https://api.fitsociety.io
    description: Production
security: []
tags:
  - name: Workout
    description: >-
      Workout V2 libraries, programmes, client plans, calendars, sessions,
      groups, settings and progress. AI operations are excluded.
  - name: OAuth
    description: Public API OAuth endpoints for server-to-server client credentials.
  - name: Health
    description: Public API token health checks.
  - name: Platform
    description: >-
      Inspect Public API client context, capabilities, scopes, and redacted
      audit logs.
  - name: Company Catalog
    description: Read and manage company profile metadata and locations.
  - name: Clients
    description: >-
      Create and manage clients through the Public API using Bearer access
      tokens.
  - name: Coaches
    description: Retrieve coaches for the authenticated company via integrations.
  - name: Calendar Events
    description: Read Public API calendar events.
  - name: Calendar Templates
    description: >-
      Read and manage event types and event templates used by calendar
      availability and bookings.
  - name: Calendar Extensions
    description: >-
      Read recurring bookings, booking requests, calendar tasks, and
      availability closure metadata.
  - name: Availability
    description: Read bookable availability slots and signed availability tokens.
  - name: Availability Management
    description: >-
      Manage coach and location availability templates used to derive bookable
      slots.
  - name: Bookings
    description: Read and manage Public API bookings.
  - name: Finance
    description: >-
      Read invoices, transactions, products, subscriptions, and memberships with
      guarded finance writes.
  - name: Credits
    description: >-
      Read company-wide and client-scoped credit allocations, mutations, and
      guarded credit adjustments.
  - name: Exports
    description: >-
      Create and monitor asynchronous company exports through Public API Bearer
      endpoints.
  - name: Webhooks
    description: >-
      Manage outbound webhook subscriptions and inspect delivery attempts
      through Public API Bearer endpoints.
  - name: Measurements
    description: Read and write client measurement entries.
  - name: Progress Photos
    description: Read client progress photo metadata and short-lived signed media URLs.
  - name: Forms
    description: Read, create, update, and archive company form templates.
  - name: Intakes
    description: Assign intake forms and read client intake assignments and submissions.
  - name: Check-ups
    description: >-
      Schedule and cancel client check-ups and read their status and
      submissions.
  - name: Documents
    description: >-
      Read client document and folder metadata, register external document
      links, update metadata, and archive documents from Public API listings.
      Binary upload, permanent deletion, and company-wide document management
      are not exposed.
  - name: Habits
    description: Read habits and habit entries.
  - name: Goals
    description: Read client goal summaries.
  - name: Conversations
    description: >-
      Read and manage direct and group chat conversations through the Public
      API.
  - name: Reports
    description: Read aggregate attendance, revenue, and retention summaries.
paths:
  /public/v1/workout/equipment/clients/{clientId}:
    get:
      tags:
        - Workout
      summary: Get client workout equipment catalog, selections, and presets
      description: >-
        Requires the workout_client_plans:read scope. This operation maps to
        /app/v1/workout/equipment/clients/:clientId and retains its Workout V2
        permission, feature-flag, and resource-scope checks.


        The clientId path parameter is resolved inside the company bound to the
        Public API token when present.
      operationId: publicWorkoutgetPublicV1WorkoutEquipmentClientsClientId
      parameters:
        - in: path
          name: clientId
          required: true
          description: Client id.
          schema:
            type: string
            example: 67f1234567890abcdef1234
      responses:
        '200':
          description: Client equipment catalog, selected items, and preset bundles.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PublicApiSuccessResponse'
                  - type: object
                    properties:
                      data:
                        $ref: >-
                          #/components/schemas/PublicWorkoutSourceGETAppV1WorkoutEquipmentClientsClientIdResponse200
              examples:
                success:
                  summary: Successful response
                  value:
                    data:
                      catalogItems:
                        - id: 67f1234567890abcdef1234
                          key: Dumbbells
                          label: Dumbbells
                          category: Free Weights
                          aliases:
                            - dumbbell
                            - db
                          family: freeWeights
                          modality: strength
                          resistanceType: freeWeight
                          movementTags:
                            - compound
                            - progressiveOverload
                          usageContexts:
                            - commercialGym
                            - homeGym
                          source: system
                          editable: false
                      selectedItems:
                        - catalogItemId: 67f1234567890abcdef1234
                          brand: Technogym
                          note: Competition set
                          quantity: 4
                      presets:
                        - key: commercialGym
                          label: Commercial Gym
                          catalogItemIds:
                            - 67f1234567890abcdef1234
                          keys:
                            - Dumbbells
                            - PowerRack
                            - LegPressMachine
                      locations:
                        - id: 67f1234567890abcdef1234
                          title: Amsterdam West
                          address: Main Street 12
                          locationType: branch
                          primary: true
                      selectedLocationId: 67f1234567890abcdef1234
                      selectionSource: location
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '400':
          description: Client id is invalid or company scope is missing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                invalidRequest:
                  summary: Invalid request
                  value:
                    error:
                      code: 400
                      key: request.invalid
                      message: The request is invalid.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '401':
          $ref: '#/components/schemas/ErrorResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                missingBearer:
                  summary: Missing Bearer token
                  value:
                    error:
                      code: 401
                      key: auth.missing_bearer
                      message: Authorization Bearer token is required.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
                invalidToken:
                  summary: Invalid or expired token
                  value:
                    error:
                      code: 401
                      key: auth.invalid_token
                      message: The access token is invalid or expired.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
                invalidClient:
                  summary: Inactive or revoked client
                  value:
                    error:
                      code: 401
                      key: auth.invalid_client
                      message: The Public API client is inactive or revoked.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '403':
          description: >-
            Caller is not coach/admin for this route, lacks company access, or
            the client is not connected to the active company.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                insufficientScopes:
                  summary: Missing required scope
                  value:
                    error:
                      code: 403
                      key: scopes.insufficient
                      message: The access token does not include the required scope.
                      details:
                        requiredScopes:
                          - required:scope
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '404':
          description: >-
            The client, company-client link, or scoped equipment data was not
            found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                notFound:
                  summary: Resource not found
                  value:
                    error:
                      code: 404
                      key: resource.not_found
                      message: The requested Public API resource was not found.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '409':
          $ref: '#/components/schemas/ErrorResponse'
        '422':
          $ref: '#/components/schemas/ErrorResponse'
        '429':
          $ref: '#/components/schemas/ErrorResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                rateLimitExceeded:
                  summary: Rate limit exceeded
                  value:
                    error:
                      code: 429
                      key: rate_limit.exceeded
                      message: Too many Public API requests. Retry later.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 0
                        resetSeconds: 1
                        retryAfterSeconds: 1
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                serverInternalError:
                  summary: Unexpected server error
                  value:
                    error:
                      code: 500
                      key: server.internal_error
                      message: An unexpected Public API server error occurred.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
      security:
        - PublicBearerAuth: []
      x-codeSamples:
        - lang: cURL
          label: cURL
          source: >-
            curl -X GET
            "https://api.fitsociety.io/public/v1/workout/equipment/clients/{clientId}"
            \
              -H "Authorization: Bearer <access_token>"
components:
  schemas:
    PublicApiSuccessResponse:
      type: object
      additionalProperties: false
      required:
        - data
        - meta
      properties:
        data:
          type: object
        meta:
          $ref: '#/components/schemas/PublicApiMeta'
    PublicWorkoutSourceGETAppV1WorkoutEquipmentClientsClientIdResponse200:
      type: object
      properties:
        catalogItems:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                example: 67f1234567890abcdef1234
              key:
                type: string
                example: Dumbbells
              label:
                type: string
                example: Dumbbells
              category:
                type: string
                example: Free Weights
              aliases:
                type: array
                items:
                  type: string
                example:
                  - dumbbell
                  - db
              family:
                type: string
                example: freeWeights
              modality:
                type: string
                enum:
                  - ''
                  - strength
                  - conditioning
                  - mobility
                  - recovery
                  - mixed
                example: strength
              resistanceType:
                type: string
                enum:
                  - ''
                  - freeWeight
                  - bodyweight
                  - machine
                  - cable
                  - band
                  - cardio
                  - mobility
                  - accessory
                  - mixed
                example: freeWeight
              movementTags:
                type: array
                items:
                  type: string
                example:
                  - compound
                  - progressiveOverload
              usageContexts:
                type: array
                items:
                  type: string
                  enum:
                    - commercialGym
                    - boutiqueStudio
                    - crossfitFunctional
                    - physioRehab
                    - homeGym
                example:
                  - commercialGym
                  - homeGym
              source:
                type: string
                enum:
                  - system
                  - companyCustom
                  - clientCustom
                example: system
              editable:
                type: boolean
                example: false
        selectedItems:
          type: array
          items:
            type: object
            required:
              - catalogItemId
            properties:
              catalogItemId:
                type: string
                example: 67f1234567890abcdef1234
              brand:
                type: string
                example: Technogym
              note:
                type: string
                example: Competition set
              quantity:
                type: integer
                minimum: 1
                maximum: 999
                example: 4
        presets:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
                enum:
                  - commercialGym
                  - boutiqueStudio
                  - crossfitFunctional
                  - physioRehab
                  - homeGym
                example: commercialGym
              label:
                type: string
                example: Commercial Gym
              catalogItemIds:
                type: array
                items:
                  type: string
                  example: 67f1234567890abcdef1234
              keys:
                type: array
                items:
                  type: string
                example:
                  - Dumbbells
                  - PowerRack
                  - LegPressMachine
        locations:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                example: 67f1234567890abcdef1234
              title:
                type: string
                example: Amsterdam West
              address:
                type: string
                example: Main Street 12
              locationType:
                type: string
                enum:
                  - branch
                  - outdoor
                  - online
                  - external
                  - temporary
                example: branch
              primary:
                type: boolean
                example: true
        selectedLocationId:
          type: string
          example: 67f1234567890abcdef1234
        selectionSource:
          type: string
          enum:
            - location
            - company
            - client
            - companyFallback
            - empty
          example: location
    PublicApiError:
      type: object
      additionalProperties: false
      required:
        - error
        - meta
      properties:
        error:
          type: object
          additionalProperties: false
          required:
            - code
            - key
            - message
          properties:
            code:
              type: integer
              example: 401
            key:
              type: string
              example: auth.invalid_token
            message:
              type: string
              example: The access token is invalid.
            details:
              type: object
              additionalProperties: true
        meta:
          $ref: '#/components/schemas/PublicApiMeta'
    ErrorResponse:
      allOf:
        - $ref: '#/components/schemas/StandardResponse'
        - example:
            status: 401
            error: true
            message: MISSING_AUTH
    PublicApiMeta:
      type: object
      additionalProperties: false
      required:
        - requestId
      properties:
        requestId:
          type: string
          description: Stable request correlation id. Mirrors `X-Request-Id` when supplied.
          example: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
        rateLimit:
          $ref: '#/components/schemas/PublicApiRateLimitMeta'
    StandardResponse:
      type: object
      properties:
        status:
          type: integer
          example: 200
        error:
          type: boolean
          example: false
        message:
          type: string
          example: SUCCESS
      required:
        - status
        - error
        - message
    PublicApiRateLimitMeta:
      type: object
      additionalProperties: false
      properties:
        limit:
          type: integer
          example: 10
        remaining:
          type: integer
          example: 9
        resetSeconds:
          type: integer
          description: Seconds until the current rate limit window resets.
          example: 1
        retryAfterSeconds:
          type: integer
          description: Present when the request was rate limited.
          example: 1
  securitySchemes:
    PublicBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Opaque
      description: >-
        Public API access token issued by `/public/v1/oauth/token`. Example:
        `Authorization: Bearer fspt_...`. Each resource request rechecks the
        token company's current provider access. Disabling access blocks
        existing tokens with `403 auth.provider_unavailable`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.