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

# List players

> Get a list of players for a network with optional filtering



## OpenAPI

````yaml https://controller.simplecloud.app/swagger/doc.json get /v0/players
openapi: 3.1.0
info:
  contact:
    email: support@swagger.io
    name: API Support
    url: http://www.swagger.io/support
  description: API for SimpleCloud Controller
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: http://swagger.io/terms/
  title: SimpleCloud Controller API
  version: '1.0'
servers:
  - url: https://controller.platform.simplecloud.app/
security: []
externalDocs:
  description: ''
  url: ''
paths:
  /v0/players:
    get:
      tags:
        - players
      summary: List players
      description: Get a list of players for a network with optional filtering
      parameters:
        - description: Network ID
          in: header
          name: X-Network-ID
          required: true
          schema:
            type: string
        - description: Network Secret
          in: header
          name: X-Network-Secret
          required: true
          schema:
            type: string
        - description: Filter by online status
          in: query
          name: online
          schema:
            type: boolean
        - description: Filter by connected server
          in: query
          name: server
          schema:
            type: string
        - description: Search by name
          in: query
          name: search
          schema:
            type: string
        - description: Sort by field (name, last_login, online_time, first_login)
          in: query
          name: sort_by
          schema:
            type: string
        - description: Sort order (asc, desc)
          in: query
          name: sort_order
          schema:
            type: string
        - description: Limit results (default 50)
          in: query
          name: limit
          schema:
            type: integer
        - description: Offset for pagination
          in: query
          name: offset
          schema:
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ListPlayersResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ErrorResponse'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ErrorResponse'
          description: Unauthorized
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ErrorResponse'
          description: Internal Server Error
components:
  schemas:
    models.ListPlayersResponse:
      description: Response for listing players
      properties:
        count:
          example: 25
          type: integer
        players:
          items:
            $ref: '#/components/schemas/models.PlayerResponse'
          type: array
          uniqueItems: false
        total:
          example: 1000
          type: integer
      type: object
    models.ErrorResponse:
      description: Generic error response
      properties:
        error:
          type: string
      type: object
    models.PlayerResponse:
      description: Player information
      properties:
        connected_proxy_name:
          example: proxy-1
          type: string
        connected_server_name:
          example: lobby-1
          type: string
        display_name:
          example: Steve
          type: string
        first_seen:
          example: '2023-01-01T12:00:00Z'
          type: string
        id:
          description: Minecraft UUID
          example: 069a79f4-44e9-4726-a5be-fca90e38aaf5
          type: string
        last_seen:
          example: '2023-06-15T18:30:00Z'
          type: string
        name:
          example: Steve
          type: string
        online:
          example: true
          type: boolean
        online_time_seconds:
          example: 36000
          type: integer
        playtime_seconds:
          example: 36000
          type: integer
        properties:
          additionalProperties:
            type: string
          type: object
        session_id:
          example: sess_abc123
          type: string
      type: object

````