NinjaOne icon

NinjaOne

Ninja One Public API documentation. <br><br>See also: <br> <a href="https://resources.ninjarmm.com/API/Ninja+RMM+Public+API+v2.0.5+Device+Filter+Syntax.pdf">Device Filter syntax</a><br><a href="https://app.ninjarmm.com/apidocs-beta/core-resources/articles/webhooks/overview">Webhooks</a>

Actions309

System → List users

AI-generated

Summary

List users from the NinjaOne system with optional filtering and pagination.

Inputs

  • Return All — Whether to retrieve all results across pages or only a single page of users.
  • Additional Fields — Optional filters including User Type (TECHNICIAN or END USER) and whether to include role information in the response.
  • Options — Additional request customizations such as custom JSON body merging, custom HTTP headers, query filters, batching controls, debug output inclusion, pagination configuration (offset-, cursor-, or URL-based), and timeout settings.

Output shape

a list/array of user objects in the response body, optionally including role information if requested

Supports pagination automatically when 'Return All' is true and pagination is configured. The output may also include debug information if enabled, showing request details like URL, headers, and body for troubleshooting.

Examples

Example 1: Fetch all technician users including their roles

Set 'Return All' to true, set Additional Fields > User Type to 'TECHNICIAN' and 'Include Roles' to true.

Example 2: Fetch only the first page of end users without roles

Set 'Return All' to false, set Additional Fields > User Type to 'END USER' and 'Include Roles' to false.

Links

Discussion