43 lines
1.1 KiB
Markdown
43 lines
1.1 KiB
Markdown
---
|
|
name: events-routes
|
|
description: Handle 2 OpenAPI operation(s) under /v1/events for the events route group.
|
|
---
|
|
|
|
# events API Routes
|
|
|
|
Handle 2 OpenAPI operation(s) under /v1/events for the events route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### get_events
|
|
|
|
- Operation ID: `get_events`
|
|
- Route: `GET /v1/events`
|
|
- Mode: READ
|
|
- Summary: List all events
|
|
- Parameters:
|
|
- `created` in `query`
|
|
- `delivery_success` in `query`
|
|
- `ending_before` in `query`
|
|
- `expand` in `query`
|
|
- `limit` in `query`
|
|
- `starting_after` in `query`
|
|
- `type` in `query`
|
|
- `types` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_events_id
|
|
|
|
- Operation ID: `get_events_id`
|
|
- Route: `GET /v1/events/{id}`
|
|
- Mode: READ
|
|
- Summary: Retrieve an event
|
|
- Parameters:
|
|
- `expand` in `query`
|
|
- `id` in `path` required
|
|
- Body: JSON request body accepted.
|