Skip to main content
POST
List Conversations

Headers

Accept
string
default:application/json

Preferred response media type.

Content-Type
string
default:application/json

Media type of the JSON request body.

Body

application/json
businessNumber
number
required

The business number for which the details to be fetched, it can be either enterprise or location business number.

apiKey
string
required

Partner specific API key provided by Birdeye for data exchange.

startDate
string

Start fetching messages from this date in MM/DD/YYYY format.

endDate
string

Fetch messages till this date in MM/DD/YYYY format.

offset
number

Message offset,the start index.

size
number

Number of messages return in the response.

contact
object

Contact details

excludeCampaignMessages
number

If passed with value 1, It will exclude campaign messages from API response.

Response

OK

totalConversations
number

The number of total conversation objects that can be retrieved through pagination.

totalMessages
string

The number of total message objects that can be retrieved through pagination.

conversations
object[]

List of conversations.

hasMore
boolean

Indicates if there are more conversations.