Skip to main content
GET
Retrieve a deal

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.

Path Parameters

id
string
required
Minimum string length: 1

Response

OK

A deal as /v1 publishes it: the deal itself plus its assignments (agents) and parties. Money is a fixed-2dp decimal string, calendar dates are YYYY-MM-DD, timestamps are ISO 8601 UTC, and null means the column is not captured rather than zero or empty.

object
any
required
id
string
required
brokerage
string
required
office
string | null
required
status
enum<string>
required

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
deal_type
string | null
required
title
string | null
required
mls_number
string | null
required
jurisdiction_code
string | null
required
address
object
required
list_price
string | null
required
Pattern: ^-?\d+\.\d{2}$
accepted_price
string | null
required
Pattern: ^-?\d+\.\d{2}$
sale_price
string | null
required
Pattern: ^-?\d+\.\d{2}$
monthly_rent
string | null
required
Pattern: ^-?\d+\.\d{2}$
lease_term_months
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
offer_date
string<date> | null
required
accepted_date
string<date> | null
required
firm_date
string<date> | null
required
close_date
string<date> | null
required
lease_start_date
string<date> | null
required
listing_expiry_date
string<date> | null
required
is_exclusive_listing
boolean | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
url
string
required
agents
object[]
required
parties
object[]
required