List External Event
List_External_EventRead-only
Retrieve a list of external events with options to filter by date and status, sort by event type, and paginate results.
Instructions
List External Events
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination. | |
| per_page | No | Number of records to show per page. (Max: 10000, 1,000 or less is recommended). | |
| sort_by | No | If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`, `status` or `event_type`. | |
| filter | No | If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at` and `status`. | |
| filter_gt | No | If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`. | |
| filter_gteq | No | If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`. | |
| filter_lt | No | If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`. | |
| filter_lteq | No | If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`. | |
| fields | No | Optional list of attribute names to include as columns in the response table. When omitted, a sensible default set is used. Useful for narrowing wide entities or surfacing fields not in the default. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |