Agents

Sales transactions where this agent was listing or selling side

POST
/v1/agents/{id}/sales

The agent's deals, newest first: every sale on which the agent is the buyer's agent or the listing / co-listing agent. side narrows to one half (buyer includes deals where the agent was on both sides; listing excludes them). Each row says which side the agent was on and carries the sale's recorded purchase loan — lender, loan officer, loan type, amount, title company — or null for a cash deal or a loan not yet on file. Pass flatFilters.mlsStatus: "SLD" for closed deals only. dealFilters adds an address search, the co-listing agent, builder / status-date filters and loan-side filters (financed, loan.* on the purchase loan). Sorts: the /v1/sales names plus listDate, builder, coListAgent, and the loan / party columns loanAmount, loanType, loanTransactionType, interestRate, lenderName, originatorName, companyName, brokerName, titleCompany, buyerName, sellerName, downPayment (one at a time; blanks last). listingAgent / soldAgent / coListAgent order by the name the row shows.

Authorization

x-api-key<token>

In: header

Path Parameters

id*string

Agent document ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/agents/string/sales" \  -H "Content-Type: application/json" \  -d '{}'
{
  "cursor": "string",
  "data": [
    {
      "address": "string",
      "builderName": "string",
      "buyer1FirstMiddle": "string",
      "buyer1Last": "string",
      "buyer2FirstMiddle": "string",
      "buyer2Last": "string",
      "buyerName": "string",
      "city": "string",
      "coListAgentId": "string",
      "coListAgentName": "string",
      "date": "string",
      "id": "string",
      "listAgentId": "string",
      "listAgentName": "string",
      "listDate": "string",
      "listOfficeName": "string",
      "listPrice": 0,
      "loan": {
        "amount": 0,
        "brokerName": "string",
        "brokerNmlsId": "string",
        "companyName": "string",
        "companyNmlsId": "string",
        "employerName": "string",
        "employerNmlsId": "string",
        "id": "string",
        "interestRate": 0,
        "lenderId": "string",
        "lenderName": "string",
        "loanType": "string",
        "originatorName": "string",
        "originatorNmlsId": "string",
        "titleCompany": "string",
        "transactionType": "string"
      },
      "mmPropertyId": "string",
      "price": 0,
      "seller1FirstMiddle": "string",
      "seller1Last": "string",
      "seller2FirstMiddle": "string",
      "seller2Last": "string",
      "sellerName": "string",
      "side": "buyer",
      "soldAgentId": "string",
      "soldAgentName": "string",
      "state": "string",
      "txType": "string",
      "zip": "string"
    }
  ],
  "total": 0,
  "truncated": true
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}