PAL Gate icon

PAL Gate

Consume PAL Portal API

Place → Get Tree

AI-generated

Summary

Fetch the hierarchical tree of Places, optionally filtered and paginated.

Inputs

  • returnAll — Whether to return all results or stop at the specified limit.
  • limit — Maximum number of results to return (1‑100).
  • skip — Number of records to skip for pagination.
  • filter — Optional search string to filter places.
  • parentPlaceId — Optional ID of a parent place to limit the tree view.
  • requestOptions — Advanced HTTP options including batching, SSL handling, proxy, and timeout.
  • allowUnauthorizedCerts — Accept responses with invalid SSL certificates.
  • proxy — HTTP proxy URL, optionally with authentication.
  • timeout — Request timeout in milliseconds.

Output shape

array of place objects representing the hierarchical tree

Pagination applies when returnAll is false; fields returned depend on the server and may include additional nested children.

Examples

Example 1: Retrieve the full place tree without limits

Set Return All to true, leave other defaults.

Example 2: Get first 20 places under a specific parent

Set Limit to 20, Parent Place ID to a known ID, optionally set Skip.

Example 3: Search for places containing "park" and get up to 10 results

Set Filter to "park", Limit to 10, Return All false.

Links

Discussion