The Conversation API offers read‑only endpoints to list conversations, fetch the events that occurred within a specific conversation, enumerate the members of that conversation, and retrieve a directory of users.
page_size(query, limit) — The number of results returned per page. The default value is `10`. The maximum value is `100`.
order(query) — Show the most (`desc`) / least (`asc`) recently created entries first
cursor(query) — 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_start(query) — Search for conversations created after this ISO8601 date
date_end(query) — Search for conversations created before this ISO8601 date
GET
/conversations/{conversation_id}/events
List Events
conversation_id(path, required) — The ID of the conversation
page_size(query, limit) — The number of results returned per page. The default value is `10`. The maximum value is `100`.
order(query) — Show the most (`desc`) / least (`asc`) recently created entries first
cursor(query) — 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
start_id(query) — The ID to start returning events at
end_id(query) — The ID to end returning events at
event_type(query) — The type of event to search for. Does not currently support custom events
GET
/conversations/{conversation_id}/members
List Members
conversation_id(path, required) — The ID of the conversation
page_size(query, limit) — The number of results returned per page. The default value is `10`. The maximum value is `100`.
order(query) — Show the most (`desc`) / least (`asc`) recently created entries first
cursor(query) — 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
GET
/users
List Users
page_size(query, limit) — The number of results returned per page. The default value is `10`. The maximum value is `100`.
order(query) — Show the most (`desc`) / least (`asc`) recently created entries first
cursor(query) — 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
4 endpoints auto-detected
curl -X GET \
"https://api.nexmo.com/v0.2/conversations"