Home
/
REST API Reference
/
Conversations
/
List all 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

SecurityHTTP: bearerAuth
Request
query Parameters
per_page
integer <= 150
Default: 20

How many results per page

starting_after
string

String used to get the next page of conversations.

header Parameters
Intercom-Version
string (intercom_version)
Default: 2.10

Intercom API version.
By default, it's equal to the version set in the app package.

Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "2.0" "2.1" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "2.10" "Unstable"
Example: 2.10
get
/conversations
Request samples
Responses
200
successful
Response Schema: application/json
type
string 
The type of object
 Enum: "list" "conversation.list"  
object or null (Cursor based pages)  
Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.
 
total_count
integer 
A count of the total number of objects.
 
Array of News Item (object) or Newsfeed (object) 
An array of Objects
 
401
Unauthorized
403
API plan restricted
Response samples
application/json
{
"type": "conversation.list",
"pages": {
"type": "pages",
"page": 1,
"per_page": 20,
"total_pages": 1
},
"total_count": 1,
"conversations": [

]
}