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

# Lista los chat users con conversaciones en la organización



## OpenAPI

````yaml https://api-v2.sofiachat.com/api/v1/openapi.json get /chat-users
openapi: 3.0.0
info:
  title: Sofia Chat API
  description: >-
    API externa de Sofia Chat para integraciones servidor-a-servidor.


    ## Autenticación

    Todas las peticiones requieren el header `X-API-Key` con una API key válida
    de la organización.


    ```

    X-API-Key: <tu_api_key>

    ```


    ## Scopes

    Cada API key tiene scopes que autorizan las operaciones:

    - `read`: acceso de lectura (endpoints GET).

    - `write`: acceso de escritura (endpoints POST, PATCH y DELETE).


    ## Rate limit

    El límite se aplica por API key (no por IP):

    - 300 peticiones/min en endpoints de lectura.

    - 60 peticiones/min en endpoints de escritura (`write`).


    Al superarlo la API responde `429 Too Many Requests`.
  version: '1.0'
  contact: {}
servers:
  - url: https://api-v2.sofiachat.com/api/v1
security: []
tags: []
paths:
  /chat-users:
    get:
      tags:
        - Usuarios de chat
      summary: Lista los chat users con conversaciones en la organización
      operationId: ChatUsersController_list
      parameters:
        - name: page
          required: false
          in: query
          description: Número de página
          schema:
            minimum: 1
            default: 1
            example: 1
            type: number
        - name: limit
          required: false
          in: query
          description: Cantidad de elementos por página
          schema:
            minimum: 1
            maximum: 100
            default: 20
            example: 20
            type: number
        - name: search
          required: false
          in: query
          description: Búsqueda de texto en nombre, email o teléfono
          schema:
            example: Juan
            type: string
        - name: type
          required: false
          in: query
          description: Filtra por canal del chat user
          schema:
            example: whatsapp
            enum:
              - chat_web
              - whatsapp
              - messenger
              - slack
              - telegram
            type: string
        - name: sortBy
          required: false
          in: query
          description: >-
            Campo de ordenamiento:
            name|email|phone|last_login|created_at|last_activity
          schema:
            example: last_activity
            type: string
        - name: sortOrder
          required: false
          in: query
          description: 'Dirección del ordenamiento: ASC|DESC'
          schema:
            example: DESC
            type: string
        - name: needHuman
          required: false
          in: query
          description: Sólo chat users que requieren intervención humana
          schema:
            example: true
            type: boolean
        - name: hasUnreadMessages
          required: false
          in: query
          description: Sólo chat users con mensajes sin leer
          schema:
            example: false
            type: boolean
        - name: dateFrom
          required: false
          in: query
          description: Fecha inicial del rango (ISO 8601)
          schema:
            example: '2026-08-01T00:00:00Z'
            type: string
        - name: dateTo
          required: false
          in: query
          description: Fecha final del rango (ISO 8601)
          schema:
            example: '2026-08-25T00:00:00Z'
            type: string
        - name: includeMessages
          required: false
          in: query
          description: Si true, incluye los mensajes de cada chat user
          schema:
            example: false
            type: boolean
      responses:
        '200':
          description: ''
      security:
        - api-key: []
components:
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: X-API-Key

````