Skip to main content
GET
List activity

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
string

Restrict the feed to a single contact (contact id or pid). When set, results are not additionally filtered by the search/bookmark contact scope.

trigger
string

Filter to events produced by a specific trigger id.

date
string

Restrict results to the day range containing this date. Parsed in the org's rep-bucket timezone (e.g. 2026-07-29).

sort
string

Sort option passed through to the feed query.

fields
string

Comma-separated list (or array) of fields to project. name and data are always included.

Contact search string used to scope which contacts' events are returned. filters is accepted as an alias.

Fuzzy-match across related campaign, trigger, and lesson names.

bookmark
string

Apply a saved bookmark's contact filter to scope the feed.

teams
string

Team id (or array of team ids — the first is used) to scope contacts by team.

public_key
string

Base64-encoded public key used to re-encrypt decrypted secret values when the org requires a public encryption key.

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.

expected_value
string

CSV export only. What the encrypted column should contain. Defaults to encrypted.

page
integer
default:1

Page number.

limit
integer

Records per page. Defaults to the limits.schedule config value.

filters
string

Search fallback, not a filter object. search takes precedence; filters is only consulted when search is absent. The value is used as a search string, so it does not behave like the filters object on other endpoints.

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

Paginated schedule entries. Returns page, pages, count and results; pages is ceil(count / limit).