Skip to main content
GET
List events

Authorizations

Authorization
string
header
required

An API key of the form mya_…, sent as Authorization: Bearer mya_…. The secret is shown once, when the key is created.

Query Parameters

type
enum<string>[]
Maximum array length: 100

Event type. New values may be added; this is not a breaking change. Handle unknown values.

Available options:
deal.created,
deal.updated,
deal.status_changed,
deal.deleted,
deal.restored,
deal.agent_added,
deal.agent_removed,
deal.primary_agent_changed,
task.created,
task.status_changed,
task.reassigned
brokerage
string[]
Maximum array length: 100
Minimum string length: 1
start
any
cursor
string

Opaque: send back a next_cursor unchanged.

Minimum string length: 1
limit
integer
default:50
Required range: 1 <= x <= 100

Response

OK

object
any
required
data
object[]
required

Something that happened. Fetch the subject for its current state.

has_more
boolean
required
next_cursor
string
required

Never null. Poll from it again; has_more false means caught up.