Skip to main content
GET
/
deals
/
{id}
Get a deal
curl --request GET \
  --url https://api.myupfront.com/v1/deals/{id} \
  --header 'x-upfront-key: <api-key>'
{
  "id": "123",
  "status": "CLOSED",
  "phase": "APPLICATION",
  "expiry_date": "2023-02-27",
  "created_at": "2023-02-27T00:00:00Z",
  "listing_contract": {
    "id": "123",
    "side": "SELLER",
    "side_split": 10000,
    "sale_price": 100000000,
    "net_agent_commission": 1850000,
    "gross_agent_commission": 2500000,
    "commission_rate": 250,
    "expected_close_date": "2023-02-27",
    "created_at": "2023-02-27T00:00:00Z",
    "address": {
      "line1": "123 Main St",
      "line2": "Apt 1",
      "city": "New York",
      "state": "NY",
      "zip": "90210"
    },
    "agent": {
      "id": "<string>",
      "email": "[email protected]",
      "first_name": "<string>",
      "last_name": "<string>"
    }
  },
  "application": {
    "id": "<string>",
    "status": "PENDING",
    "decisioned_on": "<string>",
    "created_at": "<string>",
    "deal_id": "<string>",
    "requested_amount": 123,
    "offers": [
      {
        "id": "123",
        "expiry_date_time": "2023-02-27T00:00:00Z",
        "origination_fee_percent": 0.05,
        "percent_of_commission": 0.1,
        "created_at": "2023-02-27T00:00:00Z"
      }
    ]
  },
  "quotes": [
    {
      "id": "123",
      "created_at": "2023-02-27T00:00:00Z",
      "estimated_percent_min": 500,
      "estimated_percent_max": 750,
      "estimated_amount_min": 1540125,
      "estimated_amount_max": 1581750
    }
  ],
  "contacts": [
    {
      "id": "123",
      "contactSchemaId": "123",
      "type": "SELLER",
      "fields": [
        {
          "id": "123",
          "fieldSchemaId": "123",
          "label": "Test",
          "type": "TEXT",
          "value": "<string>"
        }
      ]
    }
  ],
  "sides": [
    {
      "contact_id": "<string>",
      "gross_commission": 1,
      "agent_units": 1,
      "side_percentage": 1
    }
  ],
  "metadata": {
    "key": "value"
  },
  "external_id": "123"
}

Authorizations

x-upfront-key
string
header
required

Upfront API key

Path Parameters

id
string
required
Example:

"abc123"

Response

Retrieve a deal

id
string
required
Example:

"123"

status
string
required
Example:

"CLOSED"

phase
string
required
Example:

"APPLICATION"

expiry_date
string | null
required
Example:

"2023-02-27"

created_at
string
required
Example:

"2023-02-27T00:00:00Z"

listing_contract
object
required
application
object
required
quotes
object[]
required
contacts
object[]
required
sides
object[]
required
metadata
object
required
Example:
{ "key": "value" }
external_id
string
Example:

"123"