Skip to main content
GET
Search outbound message history by phone, email, contact or customer

Authorizations

Authorization
string
header
required

An admin session, company API token, droplet token or bot token.

Query Parameters

to
string

Exact email or phone number. Email is case-insensitive; phone numbers are normalized to E.164.

Maximum string length: 320
email
string

Alias for to, restricted to a valid email address.

Maximum string length: 320
phone
string

Alias for to, restricted to a valid phone number. Numbers without a country code are interpreted as US numbers.

Maximum string length: 64
contact_id
string

Contact numeric id or UUIDv7 in this company. Includes earlier bare-address sends to its known addresses.

customer_id
string

Legacy numeric customer id from the customers API. Includes its member history and bare-address sends to known addresses.

member_id
string<uuid>

Member UUID in this company. Includes all channels and bare-address sends to known addresses.

channel
enum<string>

Restrict to one outbound channel.

Available options:
email,
sms,
whatsapp,
push,
flow
status
enum<string>

Latest recorded delivery state. accepted and scheduled do not mean sent; delivered is provider confirmation, not proof of reading.

Available options:
accepted,
scheduled,
sent,
delivered,
failed,
refused
message_type
enum<string>

Restrict to transactional or marketing attempts.

Available options:
transactional,
marketing
query
string

All normalized whole words must occur in the subject, body or template. Case-insensitive; ignores HTML markup. No substring, phrase or semantic matching. Returns 503 while historical content is still indexing.

Maximum string length: 500
created_after
string<date-time>

Include attempts created at or after this time. This is the request time, not the delivery time.

created_before
string<date-time>

Include attempts created before this time. Must be later than created_after.

limit
integer

Page size, from 1 to 100; defaults to 25.

Required range: 1 <= x <= 100
cursor
string

Opaque next_cursor from the previous page with the same filters. Malformed cursors return 422; a cursor for different filters may restart at the first page of the current query.

Maximum string length: 4096

Response

Matching outbound attempts and the cursor for older attempts.

history_complete
boolean
required

False while older WeBot attempts in this company await import. An empty or partial page must not be treated as evidence that the person has not been contacted. This covers only the outbound pipelines documented here.

messages
object[]
required
page
object
required
status
integer
required
meta
object
required

Response metadata.