AppSys N-Central icon

AppSys N-Central

Interact with the N-Central API

Organization Unit → Get Children

AI-generated

Summary

Retrieve the child organization units of a specified organization unit in N-Central, optionally using pagination, sorting, and limiting the number of results.

Inputs

  • Org Unit ID (required) — The ID of the organization unit to retrieve children for.
  • Return All — Boolean flag to return all child units or paginate the results.
  • Limit — Maximum number of child organization units to return when pagination is used (default 50, max 1000).
  • Options — Additional options to customize the query including sorting field (Sort By), sort direction (Sort Order), and page number (Page Number, default 1).

Output shape

a list of child organization units, each as an individual JSON object in the output array

If 'Return All' is set to true, all child organization units will be returned across all pages. Otherwise, results are paginated according to 'Limit' and 'Page Number' parameters. Output data is returned within the 'json' property of each item.

Examples

Example 1: Get first 50 children units sorted ascending by a field

Set Org Unit ID to an existing org unit, 'Return All' to false, 'Limit' to 50, 'Sort By' to the desired field, and 'Sort Order' to 'ASC'.

Example 2: Get all child organization units without pagination

Set Org Unit ID and enable 'Return All'. Optionally specify 'Sort By' and 'Sort Order'.

Links

Discussion