Skip to main content
GET
List message events

Authorizations

x-conveyour-token
string
header
required

Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.

Query Parameters

contact_id
string

Filter events for a specific contact. Required unless message_id is provided.

message_id
string

Filter events for a specific message. Required unless contact_id is provided.

event
string

Filter by event type (e.g. send, open, bounce, read).

limit
integer

Maximum number of events to return. Default: 5000.

format
string

Pass csv to download results as a CSV file instead of JSON.

teams[]
string[]

Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.

Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.

Response

Success.

The common response envelope shared by all ConveYour endpoints.

status
enum<string>

ok on success, failed on error.

Available options:
ok,
failed
message
string

Human-readable description of the result.

data
object

Message delivery events. page, pages and count are present only when the request paginates — pagination is disabled whenever limit is below limits.message_events, in which case only results is returned.