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 → End user list

AI-generated

Summary

List end users of the NinjaOne system, supporting optional filters, pagination control, and custom request modifications.

Inputs

  • Return All — Whether to return all end user records or only a single page of results. Defaults to false (single page).
  • Options — Optional settings including Custom Body (merge arbitrary JSON into request body), Custom Headers (add HTTP headers), Query Filters (add query parameters for filtering), Batching (group input items into batches with intervals), Debug (include debug info about requests), Pagination (configure pagination mode, parameters, limits, and delays), and Timeout (milliseconds to wait for server response).

Output shape

a JSON object containing the list of end users according to the applied filters and pagination, including debug information if enabled.

If 'Return All' is disabled, pagination parameters control single-page results. Pagination options support offset-based, cursor-based, or next-URL-based mechanisms. Custom fields in the body and headers override standard parameters if provided. Debug output includes the full request details for troubleshooting.

Examples

Example 1: Fetch the first page of end users with a page size of 50 using offset pagination.

Set 'Return All' to false, configure pagination mode as 'offset', page parameter 'page' starting at 1, and page size 50.

Example 2: Fetch all end users without pagination.

Set 'Return All' to true; pagination parameters are ignored and all records are returned in one response, subject to API limits.

Links

Discussion