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

# List SOCKS5 users

> Returns SOCKS5 users owned by the caller. Passwords are omitted from the list.



## OpenAPI

````yaml /api-reference/mobilerun-proxy.yaml get /connect/users
openapi: 3.1.0
info:
  title: Mobilerun Proxy
  version: v1
servers:
  - url: https://api.mobilerun.ai
    description: Droidrun Cloud API
security:
  - bearerAuth: []
paths:
  /connect/users:
    get:
      tags:
        - Users
      summary: List SOCKS5 users
      description: >-
        Returns SOCKS5 users owned by the caller. Passwords are omitted from the
        list.
      operationId: ListUsers
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/PageSize'
        - description: >-
            Filter to users bound to this proxy. Users not bound to it
            (including unbound users) are excluded.
          in: query
          name: proxyId
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserList'
          description: The caller's SOCKS5 users, without credentials.
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - UserIDHeader: []
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Mobilerun from '@mobilerun/sdk';

            const client = new Mobilerun();

            const users = await client.connect.users.list();

            console.log(users.items);
        - lang: Python
          source: |-
            from mobilerun_sdk import Mobilerun

            client = Mobilerun()
            users = client.connect.users.list()
            print(users.items)
        - lang: Go
          source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/stainless-sdks/droidrun-cloud-go\"\n)\n\nfunc main() {\n\tclient := mobileruncloud.NewClient()\n\tusers, err := client.Connect.Users.List(context.TODO(), mobileruncloud.ConnectUserListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", users.Items)\n}\n"
        - lang: CLI
          source: mobilerun-cloud connect:users list
components:
  parameters:
    Page:
      description: Page number (1-based).
      in: query
      name: page
      schema:
        default: 1
        minimum: 1
        type: integer
    PageSize:
      description: Number of items per page.
      in: query
      name: pageSize
      schema:
        default: 20
        maximum: 100
        minimum: 1
        type: integer
  schemas:
    UserList:
      description: A page of SOCKS5 users.
      properties:
        items:
          items:
            $ref: '#/components/schemas/User'
          type: array
        pagination:
          $ref: '#/components/schemas/PaginationMeta1'
      required:
        - items
        - pagination
      type: object
    User:
      description: A SOCKS5 credential without its password.
      properties:
        createdAt:
          format: date-time
          type: string
        id:
          format: uuid
          type: string
        proxyId:
          description: >-
            The proxy this user routes to (dedicated routing), or null if
            unbound.
          format: uuid
          nullable: true
          type: string
        username:
          type: string
      required:
        - id
        - username
        - createdAt
      type: object
    PaginationMeta1:
      description: Pagination metadata for a list response.
      properties:
        hasNext:
          description: Whether a next page exists.
          type: boolean
        hasPrev:
          description: Whether a previous page exists.
          type: boolean
        page:
          description: Current page number (1-based).
          type: integer
        pageSize:
          description: Number of items per page.
          type: integer
        pages:
          description: Total number of pages.
          type: integer
        total:
          description: Total number of items across all pages.
          type: integer
      required:
        - page
        - pageSize
        - total
        - pages
        - hasNext
        - hasPrev
      type: object
    ErrorResponse1:
      description: A Problem Details (RFC 7807-style) error response.
      properties:
        detail:
          description: Human-readable explanation of this occurrence.
          type: string
        errors:
          description: Per-input errors, when applicable.
          items:
            $ref: '#/components/schemas/ErrorDetail1'
          type: array
        status:
          description: HTTP status code.
          type: integer
        title:
          description: Short, human-readable summary of the error type.
          type: string
      required:
        - title
        - status
        - detail
        - errors
      type: object
    ErrorDetail1:
      description: A single error, locating an offending input where applicable.
      properties:
        location:
          description: Path to the offending input, e.g. "body.proxyId".
          type: string
        message:
          description: Human-readable description of this error.
          type: string
        value:
          description: The offending value, when available.
      required:
        - location
        - message
      type: object
  responses:
    Unauthorized:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ErrorResponse1'
      description: The X-User-ID header was missing or invalid.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Opaque
      description: Bearer token via Authorization header

````