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 contacts

AI-generated

Summary

List ticketing contacts from the NinjaOne API, supporting pagination, filtering, batching, and custom request configurations.

Inputs

  • returnAll — Boolean flag to return all contacts across all pages or only a single page of results.
  • options — Optional additional settings including custom request body JSON, custom HTTP headers, query-string filters (key-value pairs), batching controls (items per batch and interval), debug mode, pagination configuration (mode, page size, cursor parameters, paths, limits, and delays), and request timeout in milliseconds.

Output shape

a JSON object representing a page or multiple pages of contact records from the API, optionally augmented by debug information if enabled

When pagination is enabled and returnAll is true, multiple pages are fetched according to the pagination settings. The contacts data is extracted from the response typically as an array of items, path configurable via options. Debug mode includes detailed request data for troubleshooting. Error handling and partial response behavior follow NinjaOne API conventions.

Examples

Example 1: Retrieve all ticketing contacts without filters, using default pagination.

Set 'Return All' to true; leave other options as defaults.

Example 2: Retrieve a single first page of contacts with a custom filter.

Set 'Return All' to false; under 'Query Filters' add required filter key and value.

Links

Discussion