get Conversations

GET {{baseUrl}}/conversations?subdomain={{subdomain}}&location_id={{location_id}}&page=1&per_page=5&messages=<integer>&messages_since=<dateTime>&updated_since=<dateTime>&include_messages=false

Get a list of conversations

Request Params

KeyDatatypeRequiredDescription
subdomainstring(Required) Used to scope the request to the specified institution
location_idstring(Required) Used to scope the request to the specified institution
pagenumberPage number. Starts with page 1
per_pagenumberNumber of results to return per page. Defaults is 5 per page and Max 100 per page
messagesstringNumber of messages to include in each result
messages_sincestringOnly 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_sincestringOnly 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_messagesbooleanInclude conversation messages

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;code&quot;:&quot;\u003cboolean\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;error&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;data&quot;:[{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;created_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;updated_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;patient&quot;:{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;first_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;middle_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;last_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;created_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;updated_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;institution_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;foreign_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;foreign_id_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;bio&quot;:&quot;\u003cobject\u003e&quot;,&quot;inactive&quot;:&quot;\u003cboolean\u003e&quot;,&quot;last_sync_time&quot;:&quot;\u003cstring\u003e&quot;,&quot;guarantor_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;unsubscribe_sms&quot;:&quot;\u003cboolean\u003e&quot;},&quot;messages&quot;:[{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;body&quot;:&quot;\u003cstring\u003e&quot;,&quot;created_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;updated_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;conversation_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;seen_by&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;user_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;attachment_file_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;attachment_content_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;attachment_file_size&quot;:&quot;\u003cinteger\u003e&quot;,&quot;attachment_updated_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;sms_msg_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;sender_info&quot;:{&quot;name&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;image&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;meta_type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;user_id&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},&quot;attachment_url&quot;:&quot;\u003cstring\u003e&quot;,&quot;is_custom_reminder_response&quot;:&quot;\u003cboolean\u003e&quot;,&quot;created_at_with_tz&quot;:&quot;\u003cstring\u003e&quot;,&quot;timezone_offset&quot;:&quot;\u003cstring\u003e&quot;},{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;body&quot;:&quot;\u003cstring\u003e&quot;,&quot;created_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;updated_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;conversation_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;seen_by&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;user_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;attachment_file_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;attachment_content_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;attachment_file_size&quot;:&quot;\u003cinteger\u003e&quot;,&quot;attachment_updated_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;sms_msg_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;sender_info&quot;:{&quot;name&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;image&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;meta_type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;user_id&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},&quot;attachment_url&quot;:&quot;\u003cstring\u003e&quot;,&quot;is_custom_reminder_response&quot;:&quot;\u003cboolean\u003e&quot;,&quot;created_at_with_tz&quot;:&quot;\u003cstring\u003e&quot;,&quot;timezone_offset&quot;:&quot;\u003cstring\u003e&quot;}]},{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;created_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;updated_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;patient&quot;:{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;first_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;middle_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;last_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;created_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;updated_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;institution_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;foreign_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;foreign_id_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;bio&quot;:&quot;\u003cobject\u003e&quot;,&quot;inactive&quot;:&quot;\u003cboolean\u003e&quot;,&quot;last_sync_time&quot;:&quot;\u003cstring\u003e&quot;,&quot;guarantor_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;unsubscribe_sms&quot;:&quot;\u003cboolean\u003e&quot;},&quot;messages&quot;:[{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;body&quot;:&quot;\u003cstring\u003e&quot;,&quot;created_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;updated_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;conversation_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;seen_by&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;user_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;attachment_file_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;attachment_content_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;attachment_file_size&quot;:&quot;\u003cinteger\u003e&quot;,&quot;attachment_updated_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;sms_msg_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;sender_info&quot;:{&quot;name&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;image&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;meta_type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;user_id&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},&quot;attachment_url&quot;:&quot;\u003cstring\u003e&quot;,&quot;is_custom_reminder_response&quot;:&quot;\u003cboolean\u003e&quot;,&quot;created_at_with_tz&quot;:&quot;\u003cstring\u003e&quot;,&quot;timezone_offset&quot;:&quot;\u003cstring\u003e&quot;},{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;body&quot;:&quot;\u003cstring\u003e&quot;,&quot;created_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;updated_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;conversation_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;seen_by&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;user_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;attachment_file_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;attachment_content_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;attachment_file_size&quot;:&quot;\u003cinteger\u003e&quot;,&quot;attachment_updated_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;sms_msg_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;sender_info&quot;:{&quot;name&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;image&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;meta_type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;user_id&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},&quot;attachment_url&quot;:&quot;\u003cstring\u003e&quot;,&quot;is_custom_reminder_response&quot;:&quot;\u003cboolean\u003e&quot;,&quot;created_at_with_tz&quot;:&quot;\u003cstring\u003e&quot;,&quot;timezone_offset&quot;:&quot;\u003cstring\u003e&quot;}]}],&quot;count&quot;:&quot;\u003cinteger\u003e&quot;}