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

# List Users

> List users with pagination, sorting, and search.



## OpenAPI

````yaml https://api.openwearables.io/openapi.json get /api/v1/users
openapi: 3.1.0
info:
  title: Open Wearables API
  version: 0.1.0
servers: []
security: []
paths:
  /api/v1/users:
    get:
      tags:
        - 'External: Users'
      summary: List Users
      description: List users with pagination, sorting, and search.
      operationId: list_users_api_v1_users_get
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            description: Page number (1-based)
            default: 1
            title: Page
          description: Page number (1-based)
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Number of results per page
            default: 20
            title: Limit
          description: Number of results per page
        - name: sort_by
          in: query
          required: false
          schema:
            anyOf:
              - enum:
                  - created_at
                  - email
                  - first_name
                  - last_name
                  - last_synced_at
                type: string
              - type: 'null'
            description: Field to sort by
            default: created_at
            title: Sort By
          description: Field to sort by
        - name: sort_order
          in: query
          required: false
          schema:
            enum:
              - asc
              - desc
            type: string
            description: Sort order
            default: desc
            title: Sort Order
          description: Sort order
        - name: search
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Search across first_name, last_name, and email (partial match)
            title: Search
          description: Search across first_name, last_name, and email (partial match)
        - name: email
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: email
              - type: 'null'
            description: Filter by exact email
            title: Email
          description: Filter by exact email
        - name: external_user_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Filter by external user ID. Deprecated: no data-fetching endpoint
              (timeseries, workouts, sleep, summaries, health-scores, etc.)
              accepts external_user_id - they all require the Open Wearables
              UUID. This field was added early in the project but never wired
              into those endpoints, so it only works as a filter on GET /users.
              Store the UUID returned by POST /users in your own system instead.
            deprecated: true
            title: External User Id
          description: >-
            Filter by external user ID. Deprecated: no data-fetching endpoint
            (timeseries, workouts, sleep, summaries, health-scores, etc.)
            accepts external_user_id - they all require the Open Wearables UUID.
            This field was added early in the project but never wired into those
            endpoints, so it only works as a filter on GET /users. Store the
            UUID returned by POST /users in your own system instead.
          deprecated: true
        - name: X-Open-Wearables-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Open-Wearables-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OldPaginatedResponse_UserRead_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - OAuth2PasswordBearer: []
components:
  schemas:
    OldPaginatedResponse_UserRead_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/UserRead'
          type: array
          title: Items
        total:
          type: integer
          minimum: 0
          title: Total
          description: Total number of items matching the query
        page:
          type: integer
          minimum: 1
          title: Page
          description: Current page number (1-based)
        limit:
          type: integer
          exclusiveMinimum: 0
          title: Limit
          description: Number of items per page
        pages:
          type: integer
          title: Pages
          description: Total number of pages.
          readOnly: true
        has_next:
          type: boolean
          title: Has Next
          description: Whether there is a next page.
          readOnly: true
        has_prev:
          type: boolean
          title: Has Prev
          description: Whether there is a previous page.
          readOnly: true
      type: object
      required:
        - items
        - total
        - page
        - limit
        - pages
        - has_next
        - has_prev
      title: OldPaginatedResponse[UserRead]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    UserRead:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        created_at:
          type: string
          format: date-time
          title: Created At
        first_name:
          anyOf:
            - type: string
            - type: 'null'
          title: First Name
        last_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Name
        email:
          anyOf:
            - type: string
              format: email
            - type: 'null'
          title: Email
        external_user_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External User Id
          description: >-
            Deprecated: no data-fetching endpoint (timeseries, workouts, sleep,
            summaries, health-scores, etc.) accepts external_user_id - they all
            require the Open Wearables UUID. This field was added early in the
            project but never wired into those endpoints, so it only works as a
            filter on GET /users. Store the UUID returned by POST /users in your
            own system instead.
          deprecated: true
        last_synced_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Synced At
        last_synced_provider:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Synced Provider
        has_active_connection:
          type: boolean
          title: Has Active Connection
          default: false
      type: object
      required:
        - id
        - created_at
      title: UserRead
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /api/v1/auth/login

````