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

OrganizationDocuments → List organization documents with field values

AI-generated

Summary

List organization documents for a specified organization ID, including their field values, with optional pagination, filtering, and request customization.

Inputs

  • organizationId (required) — Numeric identifier of the organization whose documents are to be listed.
  • returnAll — Whether to return all documents or just a single page of results. Defaults to false (single page).
  • options.customBody — Optional JSON object to send arbitrary additional fields in the request body, merged with other parameters (custom values take priority).
  • options.headerFilters — Optional custom HTTP headers to add to the API request.
  • options.queryFilters — Optional query-string filters to refine the documents returned by specifying parameter names and values.
  • options.batching — Optional batching settings: batch size and delay interval between batches to manage rate limiting.
  • options.debug — Enable to include detailed debug information in the output about the API request URL, headers, body, and query parameters.
  • options.pagination — Settings for how to handle pagination, including mode (offset, cursor, or URL), parameter names, cursor/URL paths in response, page size, max pages, and request intervals.
  • options.timeout — Time in milliseconds to wait for server response headers before aborting the request; defaults to 300000 ms (5 minutes).

Output shape

a list of organization documents with corresponding field values, optionally including pagination metadata and debug info if enabled

Supports pagination with configurable modes and parameters. If 'returnAll' is true, retrieves all pages automatically. Debug output is included based on the debug input option. Custom headers and filters can be used to modify the request. The exact structure of returned documents depends on the API response under /v2/organization/{organizationId}/documents.

Links

Discussion