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

DocumentTemplates → List document templates with fields

AI-generated

Summary

Retrieve a list of document templates along with their associated field attributes from the NinjaOne API.

Inputs

  • Return All — Choose whether to return all document templates or just a single page of results. Defaults to false (single page).
  • Template Name — Filter results by the name of the template. Optional.
  • Include Technician Roles — Include allowed technician roles in the response if set to true. Optional.
  • Options — Optional settings for customizing the request, including custom JSON body values (which override other fields), additional HTTP headers, query-string filters, batching parameters (items per batch and interval), debug output, and pagination configuration (mode, page size, cursor parameters, max pages, etc.).
  • Timeout (ms) — Maximum time in milliseconds to wait for a server response before aborting the request. Defaults to 300000 (5 minutes).

Output shape

a list of document template objects each including their fields and optionally allowed technician roles depending on request parameters

Supports pagination via offset, cursor, or next-url mechanisms. When 'Return All' is enabled, all pages are fetched according to the pagination settings. When debug is enabled, detailed information about requests is included in each output item under a debug entry.

Examples

Example 1: Return all document templates with fields and allowed technician roles, filtered by template name containing 'Invoice'.

Set 'Return All' to true, 'Template Name' to 'Invoice', 'Include Technician Roles' to true.

Links

Discussion