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

Queries → Scoped custom fields detailed report

AI-generated

Summary

Fetches a detailed report of scoped custom fields from NinjaOne, supporting pagination, filtering, and field selection to tailor the dataset returned.

Inputs

  • Return All — Boolean flag to decide whether to retrieve all available results or just a single page.
  • Additional Fields — Collection of optional filters including cursor for pagination, page size limit, updatedAfter date to filter updated custom fields, specific fields to include, scopes to filter by, and whether to expose secure values in plain text.
  • Options — Collection of advanced request customizations such as sending a custom JSON body merged into the request, adding custom HTTP headers, applying query filters, batching requests, enabling debug output, setting pagination mode and parameters, and specifying request timeout.

Output shape

a list of detailed scoped custom fields records, potentially paginated depending on the Return All setting and pagination options.

The output includes the detailed scoped custom fields information fetched from the /v2/queries/scoped-custom-fields-detailed NinjaOne endpoint. Pagination can be controlled via Return All and pagination options; additional filtering and customizations affect the query but do not change the data structure of each record. Debug mode outputs request metadata alongside data. If page size or fields are specified, they control the size and shape of each page returned.

Examples

Example 1: Retrieve all scoped custom fields updated after January 1, 2024, including secure values as plain text.

Set 'Return All' to true, 'Updated After' to '2024-01-01', and 'Show Secure Values' to true.

Links

Discussion