Get Schedule Events
garoon-get-schedule-eventsRetrieve Garoon schedule events for a specified target and date range. Control privacy, limit, and offset for targeted results.
Instructions
Search for schedule events in a specified period in Garoon
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of events to return (1-1000, default: 100 - server default) | |
| offset | No | Starting position for results (0 or greater, default: 0 - server default) | |
| target | Yes | Target ID as a numeric string (e.g., 12345) - user ID, organization ID, or facility ID | |
| rangeEnd | Yes | End datetime of the search range in RFC 3339 format (e.g., 2024-01-07T23:59:59+09:00). Must be after rangeStart | |
| rangeStart | Yes | Start datetime of the search range in RFC 3339 format (e.g., 2024-01-01T00:00:00+09:00). Must be before rangeEnd | |
| targetType | No | Type of target: 'user', 'organization', or 'facility' (default: 'user') | user |
| showPrivate | No | Whether to include private events in the search results. When true, includes both public and private events. When false, only public events are returned. NOTE: If GAROON_PUBLIC_ONLY is set to 'true', this parameter will be automatically overridden to false and only public events will be returned, regardless of the value specified |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | Error message. Present on error | |
| result | No | Result of the operation. Present on success | |
| status | No | HTTP status code from the Garoon API. Present only when the error is an HTTP error response | |
| responseText | No | Raw response body from the Garoon API. Present only when the error is an HTTP error response |