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

# Get users



## OpenAPI

````yaml /openapi.yaml get /users
openapi: 3.0.0
info:
  title: Ziik API
  version: '1.0'
servers: []
security: []
tags:
  - name: Auth
    description: Auth
  - name: Posts
    description: Posts
  - name: Counters
    description: Counters
  - name: Groups
    description: Groups
  - name: Languages
    description: Languages
  - name: Timezones
    description: Timezones
  - name: Units
    description: Units
  - name: User unit memberships
    description: User unit memberships
  - name: Users
    description: Users
  - name: User types
    description: User types
  - name: Conversations
    description: Conversations
paths:
  /users:
    get:
      tags:
        - Users
      operationId: 7e2f5799553ec93c9c43e2a58490d447
      parameters:
        - name: basic
          in: query
          description: Return basic user information instead of full user information
          required: false
          schema:
            type: boolean
        - name: limit
          in: query
          description: Limit the number of users returned
          required: false
          schema:
            type: integer
        - name: page
          in: query
          description: Page number
          required: false
          schema:
            type: integer
        - name: search
          in: query
          description: Search query
          required: false
          schema:
            type: string
        - name: sort
          in: query
          description: Sort by
          required: false
          schema:
            type: string
        - name: order
          in: query
          description: Order direction
          required: false
          schema:
            type: string
        - name: filter
          in: query
          description: Filter by
          required: false
          schema:
            type: string
      responses:
        '200':
          description: A list of users.
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BasicUser'
                type: object
components:
  schemas:
    BasicUser:
      properties:
        id:
          type: integer
          example: 1
        first_name:
          type: string
          example: John
        last_name:
          type: string
          example: Doe
        name:
          type: string
          example: John Doe
        title:
          type: string
          example: Manager
        active:
          type: boolean
          example: true
        avatar:
          description: Avatar image or null
          type: object
          nullable: true
        archived_at:
          description: Conversation participant archived timestamp or null
          type: integer
          format: int64
          nullable: true
        participant_type:
          description: Conversation participant type when present
          type: string
          nullable: true
        subtext:
          description: Short descriptive text combining title/unit/department
          type: string
          example: Manager - HQ (Sales)
        department:
          properties:
            id:
              type: integer
              example: 10
            name:
              type: string
              example: Sales
          type: object
          nullable: true
        unit:
          properties:
            id:
              type: integer
              example: 5
            name:
              type: string
              example: HQ
          type: object
          nullable: true
      type: object

````