messages

List Messages

Changed on

List messages exchanged in the workspace.

Requires the messages:read scope on the API key.

get/v1/messages

Request

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

Query parameters

pageinteger

Page number.

sizeinteger

Number of items per page.

sort_by'sent_at'

Field to sort by.

sort_order'asc' | 'desc'

Sort direction.

contact_idstring uuid nullable

Filter by contact linked to the message sequence.

sequence_idstring uuid nullable

Filter by sequence run.

channel'EMAIL' | 'LINKEDIN' | 'CALENDAR' | 'MANUAL'

Filter by channel.

direction'INBOUND' | 'OUTBOUND'

Filter by message direction.

created_at_afterstring date-time nullable

Return messages sent strictly after this timestamp.

created_at_beforestring date-time nullable

Return messages sent strictly before this timestamp.

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