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

# List users

> Returns all users you have access to with profile information. Results are filtered by your account permissions — you'll see yourself and any users connected to you via partnerships.



## OpenAPI

````yaml https://dashboard.researchanddesire.com/openapi.yaml get /users
openapi: 3.1.0
info:
  title: Research And Desire API
  description: >
    The Research And Desire API provides programmatic access to your devices and
    data.


    All responses follow a standard envelope format:

    - Success: `{ "ok": true, "data": <result> }`

    - Error: `{ "ok": false, "error": "<message>" }`


    ## Pagination


    List endpoints support pagination via query parameters:

    - `limit`: Number of records to return (default: 50, max: 100)

    - `offset`: Number of records to skip (default: 0)


    Paginated responses include pagination metadata alongside the data array.


    ## Authentication


    All endpoints require a Bearer token in the Authorization header.

    Tokens can be created in the Dashboard settings (requires Ultra
    subscription).
  version: 1.0.0
  contact:
    name: Research And Desire Support
    url: https://www.researchanddesire.com/support
servers:
  - url: https://dashboard.researchanddesire.com/api/v1
    description: Production API
security:
  - bearerAuth: []
tags:
  - name: Users
    description: User account information
  - name: DTT
    description: Deepthroat Trainer devices
  - name: DTT Templates
    description: Deepthroat Trainer training program templates
  - name: DTT Sessions
    description: Deepthroat Trainer training session history
  - name: LKBX
    description: Chastity Lockbox devices
  - name: Lock Templates
    description: Lock templates
  - name: Lock Sessions
    description: Lock session management
  - name: OSSM
    description: Open Source Sex Machine devices
paths:
  /users:
    get:
      tags:
        - Users
      summary: List users
      description: >-
        Returns all users you have access to with profile information. Results
        are filtered by your account permissions — you'll see yourself and any
        users connected to you via partnerships.
      operationId: listUsers
      parameters:
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Offset'
      responses:
        '200':
          description: List of users
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserListResponse'
              example:
                ok: true
                data:
                  data:
                    - id: 42
                      username: alice_trainer
                      accountType: user
                      subscriptionTier: ultra
                      league: 3
                      rank: 150
                      totalPoints: 12500
                      matchPoints: 800
                      profileImage: https://example.com/avatar.jpg
                      profileDescription: Hello world
                      profileTitle: Expert Trainer
                  pagination:
                    limit: 50
                    offset: 0
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    Limit:
      name: limit
      in: query
      required: false
      description: Number of records to return (default 50, max 100)
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 50
        example: 50
    Offset:
      name: offset
      in: query
      required: false
      description: Number of records to skip (default 0)
      schema:
        type: integer
        minimum: 0
        default: 0
        example: 0
  schemas:
    UserListResponse:
      type: object
      required:
        - ok
        - data
      properties:
        ok:
          type: boolean
          const: true
        data:
          type: object
          required:
            - data
            - pagination
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/UserSummary'
            pagination:
              $ref: '#/components/schemas/Pagination'
    UserSummary:
      type: object
      properties:
        id:
          type: integer
          description: Internal user ID
        username:
          type: string
          nullable: true
          description: User's unique username (from profile)
        accountType:
          type: string
          enum:
            - user
            - support
            - admin
            - superadmin
          description: Account type
        subscriptionTier:
          type: string
          nullable: true
          enum:
            - ultra
            - pioneer
            - founder
            - employee
          description: Subscription tier (null if no subscription)
        league:
          type: integer
          description: Current league tier
        rank:
          type: integer
          description: Leaderboard rank
        totalPoints:
          type: integer
          description: Lifetime points earned
        matchPoints:
          type: integer
          description: Points in current match period
        profileImage:
          type: string
          nullable: true
          description: URL to user's profile image
        profileDescription:
          type: string
          nullable: true
          description: User's profile bio/description
        profileTitle:
          type: string
          nullable: true
          description: User's profile title
    Pagination:
      type: object
      required:
        - limit
        - offset
      properties:
        limit:
          type: integer
          description: Number of records returned
          example: 50
        offset:
          type: integer
          description: Number of records skipped
          example: 0
    ErrorResponse:
      type: object
      required:
        - ok
        - error
      properties:
        ok:
          type: boolean
          const: false
        error:
          type: string
  responses:
    Unauthorized:
      description: Authentication required or token invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            ok: false
            error: Unauthorized
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            ok: false
            error: Internal server error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        API tokens can be created in the Dashboard settings.
        Requires an Ultra subscription.

````