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 → Device Custom Fields

AI-generated

Summary

Retrieve device custom fields defined in the NinjaOne system with support for filtering, pagination, batching, and custom request configuration.

Inputs

  • returnAll — Choose whether to return all device custom fields or just the first page of results.
  • additionalFields.scopes — Filter results by specified scopes (all, node, location, organization).
  • options.customBody — Provide arbitrary JSON to merge with the request body, overriding other fields if conflicts occur.
  • options.customHeaders — Add custom HTTP headers to include with the API request.
  • options.queryFilters — Add custom query parameters as filters for the API request.
  • options.batching — Configure batch processing with items per batch and interval between batches to handle rate limiting.
  • options.debug — Enable debug mode to include detailed request information (URL, headers, body) in the output for troubleshooting.
  • options.pagination — Configure pagination mode (offset, cursor, or URL), parameter names, page size, and limits to control how paged data is retrieved.
  • options.timeout — Set the timeout in milliseconds to wait for the server response before aborting the request.

Output shape

a list of device custom fields objects from the NinjaOne system.

Output includes all pages if 'Return All' is true and pagination is configured; otherwise only a single page of results is returned. Enabling debug adds request details to the output.

Examples

Example 1: Get first page of device custom fields

Set 'Return All' to false (default), optionally configure filters and pagination as needed.

Example 2: Retrieve all device custom fields across all scopes

Set 'Return All' to true and select scopes as 'all,node,location,organization'.

Example 3: Debug API requests to troubleshoot

Enable 'Debug' to include actual request details in the node output.

Links

Discussion