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

# Listar usuários

> Retorna os usuários do workspace com status active baseado em soft_deleted.



## OpenAPI

````yaml /openapi/liderhub.json get /v1/users
openapi: 3.0.0
info:
  title: API Liderhub
  description: >-
    API REST para gerenciamento de conversas WhatsApp com IA.


    ## Autenticação


    A autenticação é obrigatória e deve ser feita utilizando o header
    `x-company-key`, gerado diretamente na plataforma Liderhub.


    Cada workspace possui uma chave própria, garantindo isolamento e segurança.


    ## Recursos disponíveis


    | Recurso | Descrição |

    |---------|-----------|

    | **Connections** | Gerenciar conexões WhatsApp do workspace |

    | **Contacts** | Listar, buscar, cadastrar contatos e marcar como lidos |

    | **Message** | Listar, buscar, enviar e cancelar mensagens agendadas |

    | **Agents** | Listar agentes de IA configurados |

    | **Users** | Listar usuários do workspace |

    | **Settings** | Consultar e atribuir status, origens, tags e departamentos
    aos chats |

    | **Groups** | Grupos WhatsApp: listar, detalhar, criar, atualizar
    nome/foto/configurações e gerenciar participantes e admins |

    | **Templates** | Listar, obter e enviar mensagens rápidas (templates) |


    ## Paginação


    Endpoints que retornam listas suportam paginação:

    - `page`: número da página (inicia em 1)

    - `limit`: itens por página (máximo 100)


    Retorno inclui metadados em `pagination`: page, limit, total, totalPages,
    hasNextPage, hasPreviousPage


    ## Filtros de lista (GET /v1/contacts)


    | Filtro | Tipo | Descrição |

    |--------|------|-----------|

    | `number` | string | Filtrar por número de telefone |

    | `connection` | UUID | Filtrar por conexão |

    | `id` | UUID | Filtrar por chat/contato — no máximo um resultado |

    | `department` | UUID | Filtrar por departamento |

    | `tags` | UUID | Filtrar por tag(s) - separar por vírgula |

    | `status` | UUID | Filtrar por status |

    | `stage` | enum | Filtrar por estágio: Open, Closed, Pending |

    | `hasUnread` | boolean | Filtrar contacts com mensagens não lidas |

    | `createdAfter` | ISO8601 | Criados após data |

    | `createdBefore` | ISO8601 | Criados antes de data |

    | `modifiedAfter` | ISO8601 | Modificados após data |

    | `modifiedBefore` | ISO8601 | Modificados antes de data |


    ⚠️ **Importante**: Utilize esta API de maneira responsável. Não forneça a
    credencial para terceiros.
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.liderhub.com.br
    description: Produção
security: []
tags:
  - name: Connections
    description: Gerenciar conexões WhatsApp do workspace
  - name: Contacts
    description: 'Contatos/conversas: listar e filtrar contatos.'
  - name: Message
    description: Listar, buscar, enviar e cancelar mensagens agendadas
  - name: Agents
    description: Listar agentes de IA configurados
  - name: Users
    description: Listar usuários do workspace
  - name: Settings
    description: Consultar e atribuir status, origens, tags e departamentos aos chats
  - name: Groups
    description: Gestão de grupos WhatsApp
  - name: Templates
    description: Templates / mensagens rápidas
paths:
  /v1/users:
    get:
      tags:
        - Users
      summary: Listar usuários
      description: >-
        Retorna os usuários do workspace com status active baseado em
        soft_deleted.
      operationId: UserController_findAll
      parameters: []
      responses:
        '200':
          description: Lista de usuários retornada com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersListResponseDto'
        '401':
          description: Não autorizado — chave de empresa inválida ou ausente
      security:
        - x-company-key: []
components:
  schemas:
    UsersListResponseDto:
      type: object
      properties:
        users:
          type: array
          items:
            $ref: '#/components/schemas/UserResponseDto'
      required:
        - users
    UserResponseDto:
      type: object
      properties:
        id:
          type: string
          description: User unique identifier
          example: aaaaaaaa-bbbb-cccc-dddd-111111111111
        name:
          type: object
          description: User name
          example: João Silva
        email:
          type: object
          description: User email
          example: joao.silva@example.com
        phone:
          type: object
          description: User phone
          example: '5511999999999'
        role:
          type: string
          description: User role
          example: Admin
        active:
          type: boolean
          description: Whether user is active
          example: true
      required:
        - id
        - role
        - active
  securitySchemes:
    x-company-key:
      type: apiKey
      in: header
      name: x-company-key
      description: Chave de autenticação do workspace (gerada na plataforma Liderhub)

````