Skip to main content
GET
List messages

Authorizations

x-conveyour-token
string
header
required

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

Query Parameters

types
enum<string>[]

Filter by message type(s). Valid values: contact, bookmark, trigger, campaign, trigger_lesson, trigger_wait. Invalid values are dropped; if nothing valid remains the filter falls back to all types rather than erroring.

Available options:
contact,
bookmark,
trigger,
campaign,
trigger_lesson,
trigger_wait
creators
enum<string>[]

Filter by creator type(s). Valid values: user, system, team, automatic. Omit it and all four are used. But if you pass a value and none of it is valid, the filter silently narrows to user only — the opposite of how types behaves. No error is returned either way.

Available options:
user,
system,
team,
automatic
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[]

Up to 100 messages, newest first.