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 → Get document template

AI-generated

Summary

Retrieve details of a specific document template by its ID from the NinjaOne API.

Inputs

  • documentTemplateId (required) — The unique numeric ID of the document template to retrieve.
  • includeTechnicianRoles — Optional flag to include allowed technician roles in the response.
  • customBody — Optional JSON object to send arbitrary data in the request body, overriding other body fields.
  • headerFilters — Optional set of custom HTTP headers to include in the API request.
  • queryFilters — Optional query parameters to filter or modify the request.
  • batching — Optional settings to control batching of input items and rate-limiting delays between batches.
  • debug — Flag to enable detailed debug information in the output about the actual API request made.
  • pagination — Optional pagination configuration (not typically applicable for single-item retrieval but available in common node options).
  • timeout — Time in milliseconds to wait for a server response header before aborting the request; defaults to 300,000 ms (5 minutes).

Output shape

a single JSON object representing the retrieved document template details, including fields such as ID, name, and optionally associated technician roles if requested.

Output includes a debug entry with the URL, headers, query parameters, and body if the debug option is enabled. Pagination settings usually do not affect this single-item GET operation. Errors or missing templates will result in an error response or empty result.

Examples

Example 1: Retrieve document template with ID 123 including technician roles

Set documentTemplateId to 123, enable Include Technician Roles option.

Links

Discussion