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

# List subjects

> Retrieve all subjects belonging to the authenticated partner.
Soft-deleted subjects are excluded.




## OpenAPI

````yaml /openapi.yaml get /subjects
openapi: 3.0.1
info:
  title: Ochy Partner API
  version: 1.0.0
  description: >
    The Ochy Partner API lets you integrate running biomechanical analysis into
    your application.

    Upload a video of a runner, receive detailed biomechanical metrics, joint
    angles, running style

    classification, and frame-by-frame position data.
servers:
  - url: https://partner-api.ochy-prod.com
    description: Production
security:
  - apiKey: []
paths:
  /subjects:
    get:
      tags:
        - Subjects
      summary: List subjects
      description: |
        Retrieve all subjects belonging to the authenticated partner.
        Soft-deleted subjects are excluded.
      operationId: listSubjects
      responses:
        '200':
          description: List of subjects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubjectListResponse'
              example:
                subjects:
                  - id: 550e8400-e29b-41d4-a716-446655440000
                    email: runner@example.com
                    name: Jane Smith
                    height: 1.72
                    weight: 62
                    created_at: '2025-03-20T15:30:00Z'
                count: 1
        '401':
          description: Missing API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthErrorResponse'
        '403':
          description: Invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthErrorResponse'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    SubjectListResponse:
      type: object
      properties:
        subjects:
          type: array
          items:
            $ref: '#/components/schemas/Subject'
        count:
          type: integer
          example: 5
    AuthErrorResponse:
      type: object
      properties:
        detail:
          type: string
          example: API Key is missing
    ErrorResponse:
      type: object
      properties:
        detail:
          type: string
          example: Internal server error
        code:
          type: string
          description: Machine-readable error code (present on some errors).
          example: insufficient_credits
    Subject:
      type: object
      properties:
        id:
          type: string
          example: 550e8400-e29b-41d4-a716-446655440000
        email:
          type: string
          example: runner@example.com
        name:
          type: string
          example: Jane Smith
        height:
          type: number
          description: Subject height in meters.
          example: 1.72
        weight:
          type: number
          description: Subject weight in kilograms.
          example: 62
        created_at:
          type: string
          format: date-time
          example: '2025-03-20T15:30:00Z'
  securitySchemes:
    apiKey:
      type: apiKey
      in: query
      name: apiKey
      description: Your API key, passed as a query parameter on every request.

````