Skip to main content
GET
List deals

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

id
string[]
Maximum array length: 100
Minimum string length: 1
brokerage
string[]
Maximum array length: 100
Minimum string length: 1
address
string
Required string length: 2 - 200
mls_number
string
Required string length: 1 - 50
status
enum<string>[]
Maximum array length: 100

Deal status. New values may be added; this is not a breaking change. Handle unknown values.

Available options:
SUBMITTED,
IN_PROGRESS,
READY_FOR_PAYOUT,
PAID_OUT,
COMPLETED,
FELL_THROUGH
updated_since
string<date-time>
cursor
string

Opaque: send back a next_cursor unchanged.

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

Response

OK

The /v1 list envelope. data holds this page in updated_at descending order; has_more says whether another page exists, and when it does next_cursor is the opaque token to send back as cursor to fetch it. There is no total — count what you page through.

object
any
required
data
object[]
required
has_more
boolean
required
next_cursor
string | null
required