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

Ticketing → List of users by user type

AI-generated

Summary

Retrieve a paginated list of users filtered by user type and other optional criteria from the NinjaOne Ticketing system.

Inputs

  • returnAll — Boolean to determine if all pages of results should be returned or just a single page.
  • additionalFields.pageSize — Number specifying the limit of records per page; default is 50.
  • additionalFields.anchorNaturalId — Numeric identifier of the last user from the previous page to be used as an anchor for pagination; default is 0.
  • additionalFields.searchCriteria — String to search users by first name, last name, or email address.
  • additionalFields.userType — Filter users by type, with options TECHNICIAN, END USER, or CONTACT; default is TECHNICIAN.
  • additionalFields.clientId — Numeric organization identifier to scope the user list.
  • options.customBody — JSON object to send arbitrary custom data in the request body that takes priority over other fields.
  • options.headerFilters — Array of custom HTTP headers to include in the API request.
  • options.queryFilters — Array of additional query-string filters by parameter name and value.
  • options.batching — Settings for request batching including items per batch and interval between batches.
  • options.debug — Boolean to include detailed request data (URL, headers, body) in the output for debugging.
  • options.pagination — Configuration to manage pagination mode (offset, cursor, next URL), parameter names, and limits for paging through the results.
  • options.timeout — Time in milliseconds to wait for the server response before aborting the request; default is 300000 (5 minutes).

Output shape

a list of user records as returned by the NinjaOne Ticketing API endpoint /v2/ticketing/app-user-contact

Supports full pagination automatically if 'returnAll' is enabled and pagination settings are properly configured. Output includes debug information if enabled. Returned user objects correspond to the specified user type and any applied filters.

Links

Discussion