get Conversations
GET {{baseUrl}}/conversations?subdomain={{subdomain}}&location_id={{location_id}}&page=1&per_page=20&messages=<integer>&messages_since=<dateTime>&updated_since=<dateTime>&include_messages=false
Get a list of conversations
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
subdomain | string | (Required) Used to scope the request to the specified institution | |
location_id | string | (Required) Used to scope the request to the specified institution | |
page | number | Page number. Starts with page 1 | |
per_page | number | Number of results to return per page. Defaults is 5 per page and Max 100 per page | |
messages | string | Number of messages to include in each result | |
messages_since | string | Only return messages created since specified date. Must be a parseable date/time, recommended formats are YYYY-MM-DD or YYYY-MM-DDThh:mm:ss+0000 | |
updated_since | string | Only return messages updated since specified date. Must be a parseable date/time, recommended formats are YYYY-MM-DD or YYYY-MM-DDThh:mm:ss+0000 | |
include_messages | boolean | Include conversation messages |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"code":"\u003cboolean\u003e","description":"\u003cstring\u003e","error":["\u003cstring\u003e","\u003cstring\u003e"],"data":[{"id":"\u003cinteger\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","patient":{"id":"\u003cinteger\u003e","email":"\u003cstring\u003e","first_name":"\u003cstring\u003e","middle_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e","name":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","institution_id":"\u003cinteger\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","bio":"\u003cobject\u003e","inactive":"\u003cboolean\u003e","last_sync_time":"\u003cstring\u003e","guarantor_id":"\u003cinteger\u003e","unsubscribe_sms":"\u003cboolean\u003e"},"messages":[{"id":"\u003cinteger\u003e","body":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","conversation_id":"\u003cinteger\u003e","seen_by":["\u003cstring\u003e","\u003cstring\u003e"],"user_id":"\u003cinteger\u003e","attachment_file_name":"\u003cstring\u003e","attachment_content_type":"\u003cstring\u003e","attachment_file_size":"\u003cinteger\u003e","attachment_updated_at":"\u003cstring\u003e","sms_msg_id":"\u003cinteger\u003e","sender_info":{"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"image":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"meta_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"attachment_url":"\u003cstring\u003e","is_custom_reminder_response":"\u003cboolean\u003e","created_at_with_tz":"\u003cstring\u003e","timezone_offset":"\u003cstring\u003e"},{"id":"\u003cinteger\u003e","body":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","conversation_id":"\u003cinteger\u003e","seen_by":["\u003cstring\u003e","\u003cstring\u003e"],"user_id":"\u003cinteger\u003e","attachment_file_name":"\u003cstring\u003e","attachment_content_type":"\u003cstring\u003e","attachment_file_size":"\u003cinteger\u003e","attachment_updated_at":"\u003cstring\u003e","sms_msg_id":"\u003cinteger\u003e","sender_info":{"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"image":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"meta_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"attachment_url":"\u003cstring\u003e","is_custom_reminder_response":"\u003cboolean\u003e","created_at_with_tz":"\u003cstring\u003e","timezone_offset":"\u003cstring\u003e"}]},{"id":"\u003cinteger\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","patient":{"id":"\u003cinteger\u003e","email":"\u003cstring\u003e","first_name":"\u003cstring\u003e","middle_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e","name":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","institution_id":"\u003cinteger\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","bio":"\u003cobject\u003e","inactive":"\u003cboolean\u003e","last_sync_time":"\u003cstring\u003e","guarantor_id":"\u003cinteger\u003e","unsubscribe_sms":"\u003cboolean\u003e"},"messages":[{"id":"\u003cinteger\u003e","body":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","conversation_id":"\u003cinteger\u003e","seen_by":["\u003cstring\u003e","\u003cstring\u003e"],"user_id":"\u003cinteger\u003e","attachment_file_name":"\u003cstring\u003e","attachment_content_type":"\u003cstring\u003e","attachment_file_size":"\u003cinteger\u003e","attachment_updated_at":"\u003cstring\u003e","sms_msg_id":"\u003cinteger\u003e","sender_info":{"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"image":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"meta_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"attachment_url":"\u003cstring\u003e","is_custom_reminder_response":"\u003cboolean\u003e","created_at_with_tz":"\u003cstring\u003e","timezone_offset":"\u003cstring\u003e"},{"id":"\u003cinteger\u003e","body":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","conversation_id":"\u003cinteger\u003e","seen_by":["\u003cstring\u003e","\u003cstring\u003e"],"user_id":"\u003cinteger\u003e","attachment_file_name":"\u003cstring\u003e","attachment_content_type":"\u003cstring\u003e","attachment_file_size":"\u003cinteger\u003e","attachment_updated_at":"\u003cstring\u003e","sms_msg_id":"\u003cinteger\u003e","sender_info":{"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"image":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"meta_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"attachment_url":"\u003cstring\u003e","is_custom_reminder_response":"\u003cboolean\u003e","created_at_with_tz":"\u003cstring\u003e","timezone_offset":"\u003cstring\u003e"}]}],"count":"\u003cinteger\u003e"}