NinjaOne icon

NinjaOne

Consume NinjaOne API

Actions158

Queries → Get Scoped Custom Fields Detailed Report

AI-generated

Overview

This node interacts with the NinjaOne API to retrieve a detailed report of scoped custom fields via the "Get Scoped Custom Fields Detailed Report" operation under the "Queries" resource. It is designed to fetch paginated, filtered, and scoped data about custom fields that are defined within NinjaOne, including options to control which fields and scopes to include, as well as filtering by update date.

Typical use cases include:

  • Extracting detailed metadata about custom fields for auditing or reporting purposes.
  • Synchronizing custom field definitions with external systems.
  • Monitoring changes in custom fields over time by using the "Updated After" filter.
  • Retrieving secure values either encrypted or in plain text depending on the flag.

For example, a user might want to get all custom fields updated after a certain date, limited to specific scopes, and receive the results in pages of 1000 records each.

Properties

Name Meaning
Cursor Cursor name used for pagination to continue fetching subsequent pages of results.
Page Size Limit 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".
Show Secure Values Boolean flag indicating if secure values should be returned as plain text without encryption (true/false).

Output

The output is an array of JSON objects representing the detailed report of scoped custom fields retrieved from the NinjaOne API. Each item corresponds to one record from the API response.

  • The json property contains the full response data for each fetched page.
  • If the API returns paginated data, multiple executions or cursor usage may be required to retrieve all data.
  • No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the NinjaOne API authenticated via OAuth2 credentials.
  • The node uses the NinjaOne OAuth2 API credential configured in n8n for authentication.
  • Network access to the NinjaOne API endpoint is necessary.

Troubleshooting

  • No Data Returned: Ensure that the filters such as "Updated After", "Scopes", and "Fields" are correctly set and that there is data matching those criteria.
  • Invalid Cursor: Using an incorrect or expired cursor value may result in errors or empty responses. Reset the cursor or start from the beginning.
  • API Authentication Errors: Verify that the OAuth2 credentials are valid and have not expired.
  • Rate Limits or API Errors: The NinjaOne API may enforce rate limits; handle errors gracefully and consider retry logic.
  • Missing Required Parameters: Make sure mandatory parameters like "Page Size" are set appropriately.

Common error messages will typically relate to invalid parameters, authentication failures, or network issues. Reviewing the error message details and adjusting input properties or credentials usually resolves these.

Links and References

Discussion