NinjaOne icon

NinjaOne

Consume NinjaOne API

Actions158

Queries → Get Scoped Custom Fields Report

AI-generated

Overview

This node interacts with the NinjaOne API to retrieve a report of scoped custom fields. It is designed to fetch detailed information about custom fields that are defined within various scopes in the NinjaOne system. This operation is useful for users who want to audit, analyze, or synchronize custom field data from NinjaOne into their workflows.

Typical use cases include:

  • Extracting updated custom field data after a certain date to keep external systems in sync.
  • Paginating through large sets of custom fields using cursors and page size limits.
  • Filtering the report by specific scopes or selecting particular fields to optimize data retrieval.
  • Optionally retrieving secure values in plain text for further processing or reporting.

Properties

Name Meaning
Cursor Cursor name used for pagination to continue fetching records from where the last request ended.
Page Size Limit on the number of records returned per page (default 1000).
Updated After Filter to return only custom fields updated after the specified date (ISO 8601 string).
Fields Comma-separated list of specific fields to include in the response.
Scopes Comma-separated list of scopes to filter the custom fields; default is "all" scopes.
Show Secure Values Boolean flag indicating whether secure values should be returned as plain text (true/false).

Output

The node outputs an array of JSON objects representing the scoped custom fields report retrieved from the NinjaOne API. Each item contains the data fields requested, filtered, and paginated according to the input parameters.

If secure values are included (when Show Secure Values is true), these will be presented in plain text rather than encrypted form.

No binary data output is produced by this operation.

Dependencies

  • Requires an active NinjaOne API OAuth2 credential configured in n8n for authentication.
  • The node uses NinjaOne's REST API endpoints under /v2/queries/scoped-custom-fields-report (implied by the operation context).
  • No additional environment variables or external services are required beyond the NinjaOne API access.

Troubleshooting

  • Common issues:

    • Invalid or expired API credentials will cause authentication failures.
    • Providing an invalid cursor or page size may result in empty responses or errors.
    • Incorrect date format in Updated After can lead to query failures.
    • Requesting fields or scopes that do not exist may return incomplete data or errors.
  • Error messages:

    • Authentication errors typically indicate problems with the API key or OAuth token; re-authenticate or refresh credentials.
    • Validation errors on query parameters suggest checking the format and allowed values for each property.
    • Network or API downtime errors require retrying later or verifying NinjaOne service status.

Links and References

Discussion