threads

List Threads

Changed on

List conversation threads newest first.

Requires the messages:read scope on the API key.

get/v1/threads

Request

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

Query parameters

pageinteger
sizeinteger
querystring nullable

Free text search matched against subject, participant emails, and names.

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

Filter by sequence status of the enrolled lead (e.g. WAITING_FOR_USER, WAITING_FOR_LEAD).

last_message_direction'INBOUND' | 'OUTBOUND'

Filter by direction of the latest message (INBOUND or OUTBOUND).

contact_idstring uuid nullable

Filter by contact linked to the thread.

Response

Successful Response

total_countinteger required

Total number of records matching the query.

total_pagesinteger required

Total number of pages.

has_moreboolean required

Whether more pages remain after the current one.

Changes