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 → Get user roles

AI-generated

Summary

Retrieve a list of user roles from the NinjaOne system, optionally filtered by role type and supporting pagination and custom query parameters.

Inputs

  • returnAll — Boolean to indicate whether to return all user roles or just a single page of results.
  • additionalFields.roleType — Filter user roles by type; options are 'TECHNICIAN' or 'END_USER', defaulting to 'TECHNICIAN'.
  • options.customBody — Optional JSON object to send arbitrary request body fields, which will override other fields.
  • options.headerFilters — Optional custom HTTP headers to include in the request.
  • options.queryFilters — Optional custom query string filters to refine the results.
  • options.batching — Settings to control batching of requests when processing multiple inputs.
  • options.debug — When enabled, includes request details (URL, headers, body) in the node output for debugging.
  • options.pagination — Controls how pagination is handled, including mode (offset, cursor, URL), page size, max pages, and parameter names.
  • options.timeout — Maximum time in milliseconds to wait for server response before aborting.

Output shape

a list of user roles returned from the NinjaOne API, potentially paginated or consolidated depending on settings

If 'returnAll' is false, only a single page of roles is returned. Pagination behavior can be adjusted with options. Debug information is included in output when enabled.

Links

Discussion