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

# Listar diretório de usuários

> Lista os usuários da empresa autenticada com id, nome, e-mail e status, paginados e ordenados por id. Por padrão só os ativos; `status=INACTIVE` lista os desativados. Use para resolver o e-mail de um usuário a partir do id (ex.: o dono de uma conversa).



## OpenAPI

````yaml /openapi.json get /v1/user/directory
openapi: 3.0.0
info:
  title: Nuvia API - Empresa
  description: Documentação da API para empresas
  version: '1.0'
  contact: {}
servers:
  - url: https://api.nuvia.ai
security: []
tags:
  - name: messages
    x-group: Mensagens
  - name: contacts
    x-group: Contatos
  - name: campaigns
    x-group: Campanhas
  - name: tables
    x-group: Tabelas e Listas
  - name: agents
    x-group: Agentes
  - name: conversations
    x-group: Conversas
  - name: inboxes
    x-group: Caixas de Entrada
  - name: knowledge
    x-group: Base de Conhecimento
  - name: Webhooks
    x-group: Webhooks
  - name: campaign-enrollments
    x-group: Inscrições em Campanha
  - name: custom-fields
    x-group: Campos Customizados
  - name: resources
    x-group: Arquivos e Anexos
  - name: hubspot
    x-group: HubSpot
  - name: users
    x-group: Usuários
paths:
  /v1/user/directory:
    get:
      tags:
        - users
      summary: Listar diretório de usuários
      description: >-
        Lista os usuários da empresa autenticada com id, nome, e-mail e status,
        paginados e ordenados por id. Por padrão só os ativos; `status=INACTIVE`
        lista os desativados. Use para resolver o e-mail de um usuário a partir
        do id (ex.: o dono de uma conversa).
      operationId: UsersController_findUserDirectory
      parameters:
        - name: page
          required: false
          in: query
          description: Número da página (começa em 1)
          schema:
            maximum: 9007199254740991
            exclusiveMinimum: true
            default: 1
            type: integer
            minimum: 0
        - name: rowsPerPage
          required: false
          in: query
          description: Quantidade de itens por página
          schema:
            maximum: 100
            exclusiveMinimum: true
            default: 10
            type: integer
            minimum: 0
        - name: search
          required: false
          in: query
          description: Filtra por nome ou e-mail (sem diferenciar maiúsculas).
          schema:
            maxLength: 100
            type: string
        - name: status
          required: false
          in: query
          description: 'Status dos usuários listados. Padrão: ACTIVE.'
          schema:
            default: ACTIVE
            type: string
            enum:
              - ACTIVE
              - INACTIVE
        - name: x-company-id
          in: header
          description: >-
            Identificador da empresa-alvo. Obrigatório apenas para API Keys
            globais (type=global). Ignorado para API Keys de empresa e usuários
            humanos.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Página do diretório de usuários
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDirectoryListDto'
        '401':
          description: Token inválido ou expirado
        '403':
          description: Sem permissão para acessar este recurso
      security:
        - JWT-auth: []
components:
  schemas:
    UserDirectoryListDto:
      type: object
      properties:
        result:
          type: array
          items:
            type: object
            properties:
              _id:
                type: string
                description: ID do usuário
              name:
                type: string
                description: Nome completo do usuário
              email:
                type: string
                description: E-mail do usuário
              status:
                type: string
                enum:
                  - ACTIVE
                  - INACTIVE
                description: Status do usuário
            required:
              - _id
              - name
              - email
              - status
          description: Usuários da página
        meta:
          type: object
          properties:
            page:
              type: number
              description: Página atual (começa em 1)
            rowsPerPage:
              type: number
              description: Itens por página
            totalCount:
              type: number
              description: Total de usuários no filtro
            hasNextPage:
              type: boolean
              description: Se existe próxima página
            hasPreviousPage:
              type: boolean
              description: Se existe página anterior
          required:
            - page
            - rowsPerPage
            - totalCount
            - hasNextPage
            - hasPreviousPage
          description: Metadados da paginação
      required:
        - result
        - meta
  securitySchemes:
    JWT-auth:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: Token JWT de autenticação

````

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