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

# List

> List users



## OpenAPI

````yaml /renderflow/api-reference/openapi.json get /users
openapi: 3.1.0
info:
  title: RenderFlow API
  version: 2.0.0
  description: Render farm management.
servers:
  - url: http://localhost:44442/api/v1
    description: The service on this machine. Answers without a credential
  - url: http://your-server:44442/api/v1
    description: A farm's server. Needs an API key
  - url: https://your-server:44445/api/v1
    description: A farm's server set up with TLS. Needs an API key
security:
  - bearerAuth: []
paths:
  /users:
    get:
      tags:
        - Users
      summary: List
      description: List users
      operationId: getUsers
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 50
            description: Max items to return (1-500)
          required: false
          description: Max items to return (1-500)
          name: limit
          in: query
        - schema:
            type:
              - integer
              - 'null'
            minimum: 0
            default: 0
            description: Items to skip
          required: false
          description: Items to skip
          name: offset
          in: query
        - schema:
            type: string
            description: >-
              Comma-separated sort fields, prefix with - for descending.
              Allowed: name, principal, email, created_at, updated_at
          required: false
          description: >-
            Comma-separated sort fields, prefix with - for descending. Allowed:
            name, principal, email, created_at, updated_at
          name: sort
          in: query
        - schema:
            type: string
            pattern: ^[a-fA-F0-9]{24}$
            example: 68b1f0c2a4d3e5f6a7b8c9d0
          required: false
          name: group_id
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 200
            description: Substring match on name, principal or email
          required: false
          description: Substring match on name, principal or email
          name: search
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 200
            description: Exact user name, case-sensitive
          required: false
          description: Exact user name, case-sensitive
          name: name
          in: query
      responses:
        '200':
          description: Matching users
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserList'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Not permitted for this credential
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: Validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Unhandled server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    UserList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/User'
        total:
          type: integer
          description: Total matching the filter, ignoring limit/offset
        limit:
          type: integer
        offset:
          type: integer
      required:
        - data
        - total
        - limit
        - offset
    ApiError:
      type: object
      properties:
        error:
          type: string
        tag:
          type: string
          description: The catalog entry this failure is, when it is one
        title:
          type: string
          description: The catalog entry's title
        detail:
          type: string
          description: What happened this time, and what to do
        issues:
          type: array
          items:
            type: object
            properties:
              path:
                type: array
                items:
                  anyOf:
                    - type: string
                    - type: number
              message:
                type: string
            required:
              - path
              - message
      required:
        - error
    User:
      type: object
      properties:
        id:
          type: string
          pattern: ^[a-fA-F0-9]{24}$
          example: 68b1f0c2a4d3e5f6a7b8c9d0
        principal:
          type: string
          description: OS account the user is identified by
        name:
          type: string
        alias:
          type:
            - string
            - 'null'
          default: null
        first_name:
          type:
            - string
            - 'null'
          default: null
        last_name:
          type:
            - string
            - 'null'
          default: null
        role:
          type:
            - string
            - 'null'
          default: null
        email:
          type:
            - string
            - 'null'
          default: null
        avatar:
          type:
            - string
            - 'null'
          default: null
        group_id:
          type:
            - string
            - 'null'
          pattern: ^[a-fA-F0-9]{24}$
          default: null
          example: 68b1f0c2a4d3e5f6a7b8c9d0
        signin_required:
          type: boolean
          description: >-
            They sign in with pulze.io, as the account with their email, before
            RenderFlow lets them in
        signed_in_from:
          type: array
          items:
            type: string
          description: >-
            The OS accounts they are signed in at now, as each login's
            principal. Listed by `GET /users` only
        created_at:
          type: integer
          default: 0
          example: 1785846207000
        updated_at:
          type: integer
          default: 0
          example: 1785846207000
      required:
        - id
        - principal
        - name
        - alias
        - first_name
        - last_name
        - role
        - email
        - avatar
        - group_id
        - created_at
        - updated_at
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key from Settings, API Keys. A caller on this machine needs none.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.