Skip to main content

This type defines the response payload of the getConversations method.

Types that use GetAllMyConversationsResponse

Not used by any types.

Call that uses GetAllMyConversationsResponse

GET
/conversation

Fields

Field
Type
Description
conversations
array of ConversationDetail
This array returns the conversations that match the filter criteria.

Each conversation is returned with information such as its ID, status, title, type, and creation date, as well as the latest message in the conversation.
href
string
The URI to the current page of results.
limit
integer
The value of the limit parameter submitted in the request.
next
string
The URI for the next page of results.

This value is returned if there is an additional page of results in the result set.
offset
integer
The value of the offset parameter submitted in the request.
prev
string
The URI for the previous page of results.

This is retuned if there is a previous page of results in the result set.
total
integer
The total number of entries returned in the result set.