List Threads
List conversation threads newest first.
curl --request GET \
--url https://api.topo.io/v1/threads \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.topo.io/v1/threads', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.topo.io/v1/threads"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"thread_id": "<string>",
"channel": "EMAIL",
"snippet": "<string>",
"contact_name": "<string>",
"last_message_at": "2023-11-07T05:31:56Z",
"last_message_direction": "INBOUND",
"unread": true,
"lead_status": "ACTIVE",
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"total_count": 123,
"total_pages": 123,
"has_more": true
}messages:read scope on the API key.Authorizations
Bearer API key issued from Settings → Developers.
Query Parameters
x >= 11 <= x <= 100Free text search matched against subject, participant emails, and names.
Filter by sequence status of the enrolled lead (e.g. WAITING_FOR_USER, WAITING_FOR_LEAD).
ACTIVE, SUCCEEDED, FAILED, COMPLETED, WAITING_FOR_LEAD, WAITING_FOR_USER, STOPPED_EARLY, FOUND, REFUSED Filter by direction of the latest message (INBOUND or OUTBOUND).
INBOUND, OUTBOUND Filter by contact linked to the thread.
Response
Successful Response
Records on this page.
Hide child attributes
Hide child attributes
Unique thread identifier.
Communication channel (EMAIL or LINKEDIN).
EMAIL, LINKEDIN, CALENDAR, MANUAL Preview of the latest message in the thread.
Name of the contact.
When the latest message was sent.
Direction of the latest message (INBOUND or OUTBOUND).
INBOUND, OUTBOUND Whether the thread contains unread messages.
Current status of the enrolled lead.
ACTIVE, SUCCEEDED, FAILED, COMPLETED, WAITING_FOR_LEAD, WAITING_FOR_USER, STOPPED_EARLY, FOUND, REFUSED Contact associated with the thread.
Total number of records matching the query.
Total number of pages.
Whether more pages remain after the current one.
Was this page helpful?
curl --request GET \
--url https://api.topo.io/v1/threads \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.topo.io/v1/threads', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.topo.io/v1/threads"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"thread_id": "<string>",
"channel": "EMAIL",
"snippet": "<string>",
"contact_name": "<string>",
"last_message_at": "2023-11-07T05:31:56Z",
"last_message_direction": "INBOUND",
"unread": true,
"lead_status": "ACTIVE",
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"total_count": 123,
"total_pages": 123,
"has_more": true
}