Skip to main content
GET
List sent messages

Authorizations

Authorization
string
header
required

Path Parameters

workspaceID
string
required

Workspace ID

Query Parameters

sequence_ids
integer[]
required

Sequence IDs, 1-10. Repeat the parameter per id: sequence_ids=1&sequence_ids=2

from_date
string
required

Start date (inclusive, YYYY-MM-DD)

to_date
string
required

End date (inclusive, YYYY-MM-DD). The range from from_date to to_date can span at most 30 days

timezone
string

IANA time zone name, for example America/New_York, used to resolve the dates to start and end of day (default UTC)

channel
enum<string>

Restrict to one channel (default: both)

Available options:
email,
linkedin
engagement
enum<string>

Restrict to messages that were replied to, opened, bounced or had a link clicked. opened, bounced and clicked apply to email only. Out-of-office email replies are not counted as replies

Available options:
replied,
opened,
bounced,
clicked
lead_ids
string[]

Only messages sent to these contacts, 1-50 unique ids. Repeat the parameter per id: lead_ids=a&lead_ids=b

message_type
enum<string>

Only this kind of LinkedIn message. Emails are not returned when set

Available options:
message,
inmail,
connection_note
lead_status
enum<string>

Only leads with this status in the sequence

Available options:
active,
paused,
completed,
failed,
replied,
out_of_office,
unsubscribed,
dnc,
bounced,
bounce-shield,
company_limit_reached,
stop_on_reply
sender_profile_id
integer

Only messages sent from this sender profile

order
enum<string>
default:asc

Sort by send time: oldest first or newest first (default asc)

Available options:
asc,
desc
cursor
string

Value of nextCursor from the previous response, valid only in the same workspace. Send it back unchanged with the same filters and order. Omit for the first page

limit
integer
default:50

Maximum messages per page

Required range: 1 <= x <= 100

Response

OK

data
object[]

The messages on this page.

hasMore
boolean

True when more messages follow this page.

limit
integer

The maximum number of messages on a page.

nextCursor
string

The value to send as cursor to get the next page. Present only when hasMore is true.