curl --request GET \
--url https://{organization}.rescueconsole.com/api/communications/threads \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/communications/threads', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/communications/threads"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"results": [
{
"id": "<string>",
"inbox_id": "<string>",
"inbox_name": "<string>",
"inbox_display_name": "<string>",
"subject": "<string>",
"status": "open",
"assigned_person_id": "<string>",
"assigned_person_name": "<string>",
"is_archived": true,
"archived_at": "<string>",
"is_unread": true,
"message_count": 123,
"last_message_at": "2023-11-07T05:31:56Z",
"last_from": "<string>",
"last_direction": "<string>",
"last_snippet": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"limit": 123,
"offset": 123,
"has_more": true,
"total": 123
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}List conversations
The conversations in your inboxes, the most recent message first. A key sees the inboxes that the person who made the key may read, as that person’s access stands at the moment of the request; a conversation in any other inbox answers 404, the same as one that does not exist. Needs read on Communications.
curl --request GET \
--url https://{organization}.rescueconsole.com/api/communications/threads \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/communications/threads', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/communications/threads"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"results": [
{
"id": "<string>",
"inbox_id": "<string>",
"inbox_name": "<string>",
"inbox_display_name": "<string>",
"subject": "<string>",
"status": "open",
"assigned_person_id": "<string>",
"assigned_person_name": "<string>",
"is_archived": true,
"archived_at": "<string>",
"is_unread": true,
"message_count": 123,
"last_message_at": "2023-11-07T05:31:56Z",
"last_from": "<string>",
"last_direction": "<string>",
"last_snippet": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"limit": 123,
"offset": 123,
"has_more": true,
"total": 123
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Authorizations
An API key from Settings, API keys. It starts with rc_live_.
Query Parameters
One inbox. An inbox this key may not read gives nothing, not an error.
Without it, every conversation that is not archived. With open, closed or spam, those that are not archived. With archived, only the archived ones.
open, closed, spam, archived true for unread conversations only.
true One person's conversations, or none for those nobody is handling.
How many to return. 50 unless you say, 200 at most.
1 <= x <= 200How many to skip, for the next page.
x >= 0