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

Billing → Retrieves an agreement list.

AI-generated

Summary

Retrieve a list of billing agreements from NinjaOne, optionally filtering by client ID, agreement name, default status, or product ID, with support for pagination and custom request options.

Inputs

  • Return All — Whether to return all results or only a single page of agreements.
  • Additional Fields — Optional filters including Client Id (number), Name (exact agreement name), Is Default (boolean), and Product Id (number) to narrow down agreement results.
  • Options — Additional settings allowing custom JSON request body (merged with other fields), custom HTTP headers, query filters, batching of requests, debug output, pagination settings (offset, cursor, or next URL modes with configurable parameters), and request timeout in milliseconds.

Output shape

a list of billing agreement records returned as JSON objects in an array

The response's array location can be configured via pagination.dataPath. Pagination controls determine fetching multiple pages. Debug option appends request details to output for troubleshooting.

Examples

Example 1: Retrieve all agreements with a page size of 100, filtering only default agreements for product ID 123.

Set Return All to true, Additional Fields Is Default to true and Product Id to 123, Pagination Page Size to 100.

Links

Discussion