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

RelatedItems → List host entity type related items

AI-generated

Summary

Retrieve a list of related items filtered by a specified host entity type from the NinjaOne API.

Inputs

  • entityType (required) — Select the type of entity to filter related items by, such as ORGANIZATION, DOCUMENT, LOCATION, NODE, CHECKLIST, KB_DOCUMENT, END_USER, or SOFTWARE_LICENSE.
  • options — Optional parameters to customize the request including custom JSON body fields, HTTP headers, query string filters, batching settings, debug mode, pagination controls, and request timeout.

Output shape

a paginated list of related items matching the specified entity type, returned as JSON objects; includes optional debug information when enabled.

Supports pagination with configurable modes including offset, cursor, or following next page URLs. Users can control page size, pagination parameters, maximum pages, and request intervals. Custom body, headers, and query parameters deeply merge with defaults. Debug mode adds actual request details in output for troubleshooting.

Examples

Example 1: Fetch all related NODE items with pagination

Set entityType to NODE, configure pagination to offset mode with pageParam='page' starting at 1, pageSize 50, and maxPages 0 for unlimited fetching.

Links

Discussion