provider Conversations GET
/conversations @utdk/intercom
/conversations List all conversations
You can fetch a list of all conversations.
You can optionally request the result page size and the cursor to start after to fetch the result.
{% admonition type="warning" name="Pagination" %}
You can use pagination to limit the number of results returned. The default is `20` results per page.
See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param.
{% /admonition %}
- Intercom-Version header
- enum: 1.0, 1.1, 1.2, 1.3…
- per_page query
- How many results per page
- integer
- starting_after query
- String used to get the next page of conversations.
- string
Try it
Authentication
Configure credentials for Intercom 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 intercom from '@utdk/intercom';
await intercom.listconversations({
"Intercom-Version": "2.14",
"per_page": 20
})