> ## 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.

# List user directory

> Lists the users of the authenticated company with id, name, email, and status, paginated and sorted by id. Only active users by default; `status=INACTIVE` lists the deactivated ones. Use it to resolve a user's email from their id (e.g., the owner of a conversation).



## OpenAPI

````yaml /en/openapi.json get /v1/user/directory
openapi: 3.0.0
info:
  title: Nuvia API - Company
  description: API documentation for companies
  version: '1.0'
  contact: {}
servers:
  - url: https://api.nuvia.ai
security: []
tags:
  - name: messages
    x-group: Messages
  - name: contacts
    x-group: Contacts
  - name: campaigns
    x-group: Campaigns
  - name: tables
    x-group: Tables and lists
  - name: agents
    x-group: Agents
  - name: conversations
    x-group: Conversations
  - name: inboxes
    x-group: Inboxes
  - name: knowledge
    x-group: Knowledge base
  - name: Webhooks
    x-group: Webhooks
  - name: campaign-enrollments
    x-group: Campaign enrollments
  - name: custom-fields
    x-group: Custom fields
  - name: resources
    x-group: Files and attachments
  - name: hubspot
    x-group: HubSpot
  - name: users
    x-group: Users
paths:
  /v1/user/directory:
    get:
      tags:
        - users
      summary: List user directory
      description: >-
        Lists the users of the authenticated company with id, name, email, and
        status, paginated and sorted by id. Only active users by default;
        `status=INACTIVE` lists the deactivated ones. Use it to resolve a user's
        email from their id (e.g., the owner of a conversation).
      operationId: UsersController_findUserDirectory
      parameters:
        - name: page
          required: false
          in: query
          description: Page number (starts at 1)
          schema:
            maximum: 9007199254740991
            exclusiveMinimum: true
            default: 1
            type: integer
            minimum: 0
        - name: rowsPerPage
          required: false
          in: query
          description: Number of items per page
          schema:
            maximum: 100
            exclusiveMinimum: true
            default: 10
            type: integer
            minimum: 0
        - name: search
          required: false
          in: query
          description: Filters by name or email (case-insensitive).
          schema:
            maxLength: 100
            type: string
        - name: status
          required: false
          in: query
          description: 'Status of the listed users. Default: ACTIVE.'
          schema:
            default: ACTIVE
            type: string
            enum:
              - ACTIVE
              - INACTIVE
        - name: x-company-id
          in: header
          description: >-
            Target company identifier. Required only for global API keys
            (type=global). Ignored for company API keys and human users.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Page of the user directory
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDirectoryListDto'
        '401':
          description: Invalid or expired token
        '403':
          description: You do not have permission to access this resource
      security:
        - JWT-auth: []
components:
  schemas:
    UserDirectoryListDto:
      type: object
      properties:
        result:
          type: array
          items:
            type: object
            properties:
              _id:
                type: string
                description: User ID
              name:
                type: string
                description: User's full name
              email:
                type: string
                description: User's email
              status:
                type: string
                enum:
                  - ACTIVE
                  - INACTIVE
                description: User status
            required:
              - _id
              - name
              - email
              - status
          description: Users on the page
        meta:
          type: object
          properties:
            page:
              type: number
              description: Current page (starts at 1)
            rowsPerPage:
              type: number
              description: Items per page
            totalCount:
              type: number
              description: Total users matching the filter
            hasNextPage:
              type: boolean
              description: Whether there is a next page
            hasPreviousPage:
              type: boolean
              description: Whether there is a previous page
          required:
            - page
            - rowsPerPage
            - totalCount
            - hasNextPage
            - hasPreviousPage
          description: Pagination metadata
      required:
        - result
        - meta
  securitySchemes:
    JWT-auth:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: JWT authentication token

````

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