provider Events GET
/events @utdk/front
/events List events
Lists all the detailed events which occurred in the inboxes of the company ordered in reverse chronological order (newest first).
Refer to the [Events](https://dev.frontapp.com/reference/events) topic for more information, including sorting and filtering.
Required scope: `events:*:read`
- q query
- [Search query object](https://dev.frontapp.com/docs/query-object-q) with optional properties `before`, `after`, `types`, or `inboxes`. `before` and `after` should be a timestamp in seconds with up to 3 decimal places. `types` should be a list of [event types](https://dev.frontapp.com/reference/events). `inboxes` should be a list of inbox IDs.
- string
- limit query
- Max number of results per page (max 15)
- integer
- page_token query
- Token to use to request the [next page](https://dev.frontapp.com/docs/pagination)
- string
- sort_by query
- Field used to sort the events. Only supports `created_at`.
- string
- sort_order query
- Order by which results should be sorted
- enum: asc, desc
Try it
Authentication
Configure credentials for Core API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.
Saved automatically to browser storage.
Code snippet
Updates live as you fill in the form above.
TypeScript
import front from '@utdk/front';
await front.listEvents({
"limit": 15
})