threads

Get Thread

Changed on

Fetch a single conversation thread with its messages.

Requires the messages:read scope on the API key.

get/v1/threads/{thread_id}

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/threads/{thread_id}
  • Auth: HTTP bearer

Path parameters

thread_idstring required

ID of the thread.

Query parameters

message_limitinteger

How many of the most recent messages to return.

Response

Successful Response

thread_idstring required

Unique thread identifier.

subjectstring required

Subject line of the conversation thread.

channel'EMAIL' | 'LINKEDIN' | 'CALENDAR' | 'MANUAL' required
contact_idstring uuid nullable

Contact associated with the thread.

contact_namestring nullable

Name of the contact.

sequence_template_idstring uuid nullable

Sequence template associated with the thread.

sequence_template_namestring nullable

Name of the sequence template.

lead_status'ACTIVE' | 'SUCCEEDED' | 'FAILED' | 'COMPLETED' | 'WAITING_FOR_LEAD' | 'WAITING_FOR_USER' | 'STOPPED_EARLY' | 'FOUND' | 'REFUSED'
total_message_countinteger required

Total count of messages in the thread.

Changes