provider Conversations GET
/conversations @utdk/front
/conversations List conversations
List the conversations in the company in reverse chronological order (most recently updated first). The order will respect your company's [bump settings](https://help.front.com/t/y729th/customize-when-conversations-bump-up), which determine when conversations bump to the top. For more advanced filtering, see the [search endpoint](https://dev.frontapp.com/reference/conversations#search-conversations).
Required scope: `conversations:read`
- q query
- [Search query object](https://dev.frontapp.com/docs/query-object-q) with a property `statuses`, whose value should be a list of conversation statuses (`assigned`, `unassigned`, `archived`, or `trashed`). If ticketing is enabled, this endpoint accepts either `status_categories` (`open`, `waiting`, `resolved`) or `status_ids` as an alternative.
- string
- limit query
- Max number of results per [page](https://dev.frontapp.com/docs/pagination)
- 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 conversations. Only supports `date`.
- 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.listConversations()