Skip to main content
GET
/
contacts
List Contacts
curl --request GET \
  --url https://api.myupfront.com/v1/contacts \
  --header 'x-upfront-key: <api-key>'
[
  {
    "id": "cm5gy0r4m00000cjs97rxc467",
    "contact_schema_id": "cm5gy0r4m00000cjs97rxc467",
    "created_at": "2022-01-01T00:00:00Z",
    "updated_at": "2022-01-01T00:00:00Z",
    "type": "SELLER_AGENT",
    "deal_ids": [
      "123",
      "456"
    ],
    "fields": [
      {
        "id": "123",
        "field_schema_id": "123",
        "label": "Test",
        "type": "TEXT",
        "value": "Test"
      }
    ]
  }
]

Authorizations

​
x-upfront-key
string
header
required

Upfront API key

Query Parameters

​
deal_id
string
Example:

"cm5gy0r4m00000cjs97rxc467"

​
limit
number | null
default:10
Example:

100

​
offset
number | null
default:0
Example:

0

Response

200 - application/json

List of contacts

​
id
string
required
Example:

"cm5gy0r4m00000cjs97rxc467"

​
contact_schema_id
string
required
Example:

"cm5gy0r4m00000cjs97rxc467"

​
created_at
string | null
required
Example:

"2022-01-01T00:00:00Z"

​
updated_at
string | null
required
Example:

"2022-01-01T00:00:00Z"

​
type
enum<string>
required
Available options:
BUYER,
SELLER,
TITLE_COMPANY,
LENDER,
COOP,
BUYER_AGENT,
SELLER_AGENT,
BUYER_BROKERAGE,
SELLER_BROKERAGE,
REFERRAL,
OTHER,
NONE
Example:

"SELLER_AGENT"

​
deal_ids
object[]
required
Example:
["123", "456"]
​
fields
object[]
required
Example:
[
  {
    "id": "123",
    "field_schema_id": "123",
    "label": "Test",
    "type": "TEXT",
    "value": "Test"
  }
]