Actions77
- Box Actions
- Comment Actions
- Contact Actions
- Field Actions
- File Actions
- Meeting Actions
- Newsfeed Actions
- Organization Actions
- Pipeline Actions
- Search Actions
- Snippet Actions
- Stage Actions
- Task Actions
- Team Actions
- Thread Actions
- User Actions
- Webhook Actions
Box → Get Timeline
AI-generatedSummary
Retrieve the timeline of events for a specified Streak box, optionally filtered by event types, time range, and sorted direction, with control over the number of results returned.
Inputs
- Box Key (required) — The unique identifier of the box whose timeline events you want to retrieve.
- Filters — Select specific entity types (e.g., Comments, Emails, Files) to include in the timeline; if none are selected, all event types are included.
- Start Timestamp — A date-time value that acts as a starting point to filter timeline entries. When direction is Descending, events before this time are returned; when Ascending, events after this time are returned.
- Direction — Specifies sorting order of returned entries: 'Descending' for newest entries first (events before the start timestamp), or 'Ascending' for oldest entries first (events after the start timestamp). Defaults to Descending.
- Return All — Whether to fetch and return all matching timeline entries or limit the results to the specified maximum.
- Limit — Maximum number of timeline events to return if 'Return All' is false. Defaults to 50.
Output shape
a list of timeline event records associated with the specified box
The result is paginated internally if Return All is true to include all matching events. The timeline entries returned correspond to the applied filters, date range, and direction. If filters are empty, all event types are included. The timestamp filter and direction together control the range and ordering of timeline events.
Examples
Example 1: Fetching the latest 50 timeline events for a box including only Comments and Emails
Set Box Key to the box's key; set Filters to ['COMMENTS', 'EMAILS']; leave Start Timestamp empty (defaults to latest); set Direction to 'Descending'; set Return All to false; set Limit to 50.