v1
latestOpenAPI 3.0.02026-07-1441717.8 KBconversation
List Conversations
Please note that not all data is available in the list endpoint. Once you've identified the conversation you need to work with, use the GET /conversations/:id endpoint to fetch all of the conversation details
get/conversations
Query parameters
page_sizeinteger
The number of results returned per page. The default value is 10. The maximum value is 100.
order'asc' | 'desc'
Show the most (desc) / least (asc) recently created entries first
cursorstring
The cursor to start returning results from.
You are not expected to provide this manually, but to follow the url provided in _links.next.href in the response which contains a cursor value
date_startstring
Search for conversations created after this ISO8601 date
date_endstring
Search for conversations created before this ISO8601 date
Response
OK
Example response
{
"_embedded": {
"data": {
"conversations": [
{
"_links": {
"self": {
"href": "https://api.nexmo.com/v0.2/conversations/CON-c4724477-72ac-438e-9fc0-1d3e2ff8728c"
}
},
"display_name": "Conversation with Ashley",
"id": "CON-afe887d8-d587-4280-9aae-dfa4c9227d5e",
"image_url": "https://example.com/my-image.png",
"name": "my-conversation",
"timestamp": {
"created": "2019-09-03T18:40:24.324Z"
}
}
]
}
},
"_links": {
"first": {
"href": "https://api.nexmo.com/v0.2/conversations?order=desc&page_size=10"
},
"next": {
"href": "https://api.nexmo.com/v0.2/conversations?order=desc&page_size=10&cursor=88b395c167da4d94e929705cbd63b829a650e69a39197bfd4c949f4243f60dc4babb696afa404d2f44e7775e32b967f2a1a0bb8fb259c0999ba5a4e501eaab55"
},
"prev": {
"href": "https://api.nexmo.com/v0.2/conversations?order=desc&page_size=10&cursor=069626a3de11d2ec900dff5042197bd75f1ce41dafc3f2b2481eb9151086e59aae9dba3e3a8858dc355232d499c310fbfbec43923ff657c0de8d49ffed9f7edb"
},
"self": {
"href": "https://api.nexmo.com/v0.2/conversations?order=desc&page_size=10&cursor=88b395c167da4d94e929705cbd63b82973771e7d390d274a58e301386d5762600a3ffd799bfb3fc5190c5a0d124cdd0fc72fe6e450506b18e4e2edf9fe84c7a0"
}
},
"cursor": "88b395c167da4d94e929705cbd63b82973771e7d390d274a58e301386d5762600a3ffd799bfb3fc5190c5a0d124cdd0fc72fe6e450506b18e4e2edf9fe84c7a0",
"page_size": 10
}