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

# List users

> Search the users in your organization. Requires the `users:read` scope.

Filter by user fields such as `department`, `location` or `modules`. Returns up to 1,000 users per request; use `skip` to page.



## OpenAPI

````yaml /api-reference/openapi.yaml post /api/v1/public-api/users/.search
openapi: 3.1.0
info:
  title: Juno Journey API
  version: 1.0.0
  description: >-
    The Juno public API. See the [API
    overview](https://docs.junojourney.com/integrations/api-overview) for
    authentication, scopes and limits.
servers:
  - url: https://api.the-juno.com
security:
  - BearerAuth: []
paths:
  /api/v1/public-api/users/.search:
    post:
      tags:
        - Users
      summary: List users
      description: >-
        Search the users in your organization. Requires the `users:read` scope.


        Filter by user fields such as `department`, `location` or `modules`.
        Returns up to 1,000 users per request; use `skip` to page.
      operationId: listUsers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchRequest'
            example:
              filters: {}
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  dataLength:
                    type: integer
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        _id:
                          type: string
                        primaryEmail:
                          type: string
                          format: email
                        tid:
                          type: string
                        createdAt:
                          type: string
                          format: date-time
                        displayName:
                          type: string
                        firstName:
                          type: string
                        lastName:
                          type: string
                        managerId:
                          type:
                            - string
                            - 'null'
                        modules:
                          type: array
                          items:
                            type: string
                        role:
                          type: integer
                        updatedAt:
                          type: string
                          format: date-time
                        department:
                          type: string
                        employeeId:
                          type: string
                        inactive:
                          type: boolean
                        jobTitle:
                          type: string
                        location:
                          type: string
                        positionName:
                          type: string
              example:
                dataLength: 1
                data:
                  - _id: 64f0c0ffee00000000000001
                    primaryEmail: alex.morgan@acme.com
                    tid: 64f0c0ffee00000000000002
                    createdAt: '2023-07-12T11:23:30.148Z'
                    displayName: Alex Morgan
                    firstName: Alex
                    lastName: Morgan
                    managerId: null
                    modules:
                      - lxp
                      - lms
                    role: 8
                    updatedAt: '2025-01-16T21:59:53.450Z'
                    department: ' '
                    employeeId: ' '
                    inactive: false
                    jobTitle: ' '
                    location: ' '
                    positionName: Sales manager
      security:
        - BearerAuth: []
components:
  schemas:
    SearchRequest:
      type: object
      properties:
        filters:
          type: object
          description: >-
            MongoDB-style filters. The endpoint description lists the supported
            fields.
        limit:
          type: integer
          minimum: 1
          maximum: 1000
          default: 1000
          description: Maximum number of results to return.
        skip:
          type: integer
          minimum: 0
          default: 0
          description: Number of results to skip before returning.
        sort:
          type: object
          description: 'MongoDB-style sort, for example `{ "createdAt": -1 }`.'
        select:
          type: object
          description: >-
            Fields to return, MongoDB projection style, for example `{
            "primaryEmail": 1 }`.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Personal access token. Create one in Admin → Security → Developer
        Settings → Generate Personal Access Token.

````

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