TukiGrowth icon

TukiGrowth

Interact with the TukiGrowth API

Actions185

Ephemeris → List Upcoming

AI-generated

Summary

Retrieve a list of upcoming ephemeris events within a specified number of days ahead for a given organization and optionally filtered by client, with a limit on the number of results returned.

Inputs

  • Organization (required) — Select the organization to operate in, either from a list or by providing its ID.
  • Client — Optionally select a client to filter ephemeris events, either from a list or by providing its ID.
  • Limit — Set the maximum number of ephemeris events to return (default is 10).
  • Days Ahead — Specify how many days into the future to look for upcoming ephemeris events (default is 30).
  • Options — Optional settings including 'Simplify Output' to return minimal data and 'Debug Mode' to include debug information in the output.

Output shape

a list of ephemeris event records

The returned list includes ephemeris events upcoming within the specified days ahead, limited by the provided maximum. Output can be simplified to minimal fields or include full details depending on the 'Simplify Output' option. Debug information may be included if enabled.

Examples

Example 1: Fetch up to 5 upcoming ephemeris events in the next 14 days for a specific organization and client, with simplified output.

Organization selected by ID; Client selected from list; Limit set to 5; Days Ahead set to 14; Simplify Output enabled; Debug Mode disabled.

Links

Discussion