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

Organization → Organization locations

AI-generated

Summary

Retrieve locations for a specified organization by its identifier, supporting pagination and filtering options.

Inputs

  • id (required) — Numeric identifier of the organization whose locations are to be fetched.
  • returnAll — Boolean flag to return all location entries across pages or just a single page of results.
  • options.customBody — Optional JSON object to send arbitrary additional data in the request body, which merges with default fields.
  • options.headerFilters — Custom HTTP headers to include in the API request.
  • options.queryFilters — Query string parameters for filtering the results.
  • options.batching — Settings to batch multiple input items into grouped API requests with controlled intervals.
  • options.debug — Enable to receive detailed debug information about each API request.
  • options.pagination — Configuration of pagination mode and parameters such as page size, cursor, and max pages to fetch.
  • options.timeout — Timeout in milliseconds to wait for the server response before aborting.

Output shape

A list (array) of location objects associated with the specified organization.

When returnAll is false, only a single page of locations is returned based on pagination options. Pagination supports offset-based, cursor-based, or next URL strategies. Debug data, if enabled, is included alongside the response under a debug key.

Links

Discussion