> ## 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 a client



## OpenAPI

````yaml /openapi/public-v1.json get /public/v1/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: 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, payments, products, subscriptions, memberships, and credits
      with guarded finance writes.
  - 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 form metadata and submissions, and assign forms.
  - name: Documents
    description: Read document and folder metadata only.
  - name: Habits
    description: Read habits and habit entries.
  - name: Goals
    description: Read client goal summaries.
  - name: Messaging
    description: Read client chat and message metadata.
  - name: Reports
    description: Read aggregate attendance, revenue, and retention summaries.
paths:
  /public/v1/clients/{clientId}:
    get:
      tags:
        - Clients
      summary: Get a client
      operationId: getPublicV1ClientsByClientId
      parameters:
        - name: clientId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Client fetched
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PublicApiSuccessResponse'
                  - type: object
                    properties:
                      data:
                        type: object
                        properties:
                          client:
                            $ref: '#/components/schemas/ClientDetail'
              examples:
                success:
                  summary: Successful response
                  value:
                    data:
                      client:
                        clientId: 66f7b8b1e13c8d25f4d3d90c
                        firstName: Jane
                        lastName: Doe
                        email: jane@example.com
                        emailIsPlaceholder: false
                        relationship:
                          startedAt: '2026-07-14T10:00:00.000Z'
                          assignedCoach:
                            coachId: 66f7b8b1e13c8d25f4d3d90a
                            name: John Doe
                        phoneNumber: '+31612345678'
                        gender: Female
                        dateOfBirth: '1990-01-01T00:00:00.000Z'
                        language: nl
                        lastActiveAt: '2026-07-14T10:00:00.000Z'
                        createdAt: '2026-07-14T10:00:00.000Z'
                        location:
                          addressLine1: Main street 1
                          addressLine2: Apt 2
                          zipCode: 1011AB
                          city: Amsterdam
                          country: Netherlands
                        height: '172'
                        timeZone: Europe/Amsterdam
                        profession: Designer
                        companyName: Acme
                        customFields:
                          - key: shirt_size
                            label:
                              en: string
                              nl: string
                            type: text
                            value: string
                            updatedAt: '2026-07-14T10:00:00.000Z'
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '400':
          description: >-
            Bad request. The request shape, query, path parameter, or
            idempotency header is invalid.
          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':
          description: >-
            Unauthorized. The Bearer token is missing, invalid, expired, or
            belongs to an inactive Public API client.
          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: >-
            Forbidden. The token is valid but does not include the required
            scope.
          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: Client 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
        '429':
          description: >-
            Too many requests. The Public API client or caller IP exceeded the
            rate limit.
          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: >-
            Server error. The request could not be completed because of an
            unexpected Public API server failure.
          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: bash
          label: cURL
          source: |-
            curl -H "Authorization: Bearer <access_token>" \
              https://api.fitsociety.io/public/v1/clients/<clientId>
components:
  schemas:
    PublicApiSuccessResponse:
      type: object
      additionalProperties: false
      required:
        - data
        - meta
      properties:
        data:
          type: object
        meta:
          $ref: '#/components/schemas/PublicApiMeta'
    ClientDetail:
      allOf:
        - $ref: '#/components/schemas/ClientSummary'
        - type: object
          properties:
            phoneNumber:
              type: string
              example: '+31612345678'
            gender:
              type: string
              example: Female
            dateOfBirth:
              type:
                - string
                - 'null'
              format: date-time
              example: '1990-01-01T00:00:00.000Z'
            language:
              type: string
              example: nl
            lastActiveAt:
              type:
                - string
                - 'null'
              format: date-time
            createdAt:
              type:
                - string
                - 'null'
              format: date-time
            relationship:
              type: object
              properties:
                startedAt:
                  type:
                    - string
                    - 'null'
                  format: date-time
                assignedCoach:
                  type:
                    - object
                    - 'null'
                  properties:
                    coachId:
                      type: string
                      example: 66f7b8b1e13c8d25f4d3d90a
                    name:
                      type: string
                      example: John Doe
            location:
              type: object
              properties:
                addressLine1:
                  type: string
                  example: Main street 1
                addressLine2:
                  type: string
                  example: Apt 2
                zipCode:
                  type: string
                  example: 1011AB
                city:
                  type: string
                  example: Amsterdam
                country:
                  type: string
                  example: Netherlands
            height:
              type: string
              example: '172'
            timeZone:
              type: string
              example: Europe/Amsterdam
            profession:
              type: string
              example: Designer
            companyName:
              type: string
              example: Acme
            customFields:
              type: array
              items:
                $ref: '#/components/schemas/ClientCustomFieldValue'
    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'
    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'
    ClientSummary:
      type: object
      properties:
        clientId:
          type: string
          example: 66f7b8b1e13c8d25f4d3d90c
        firstName:
          type: string
          example: Jane
        lastName:
          type: string
          example: Doe
        email:
          type: string
          format: email
          example: jane@example.com
        emailIsPlaceholder:
          type: boolean
          example: false
        relationship:
          type: object
          properties:
            status:
              type: string
              example: active
            memberStatus:
              type: string
              example: active
            portalAccessStatus:
              type: string
              example: enabled
            assignedCoach:
              type:
                - object
                - 'null'
              properties:
                name:
                  type: string
                  example: John Doe
    ClientCustomFieldValue:
      type: object
      properties:
        key:
          type: string
          example: shirt_size
        label:
          $ref: '#/components/schemas/LocalizedText'
        type:
          type: string
          example: text
        value:
          oneOf:
            - type: string
            - type: number
            - type: boolean
            - type: 'null'
        updatedAt:
          type:
            - string
            - 'null'
          format: date-time
    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
    LocalizedText:
      type: object
      properties:
        en:
          type: string
        nl:
          type: string
  securitySchemes:
    PublicBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Opaque
      description: >-
        Public API access token issued by `/public/v1/oauth/token`. Example:
        `Authorization: Bearer fspt_...`.

````