Agents

Loan officers the agent worked with (pre-aggregated)

POST
/v1/agents/{id}/breakdowns/originators

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/breakdowns/originators" \  -H "Content-Type: application/json" \  -d '{}'
{
  "cursor": "string",
  "data": [
    {
      "company": {
        "name": "string",
        "nmlsId": "string"
      },
      "excluded": 0,
      "id": "string",
      "label": "string",
      "name": "string",
      "office": {
        "id": "string",
        "name": "string"
      },
      "pctUnits": 0,
      "pctVolume": 0,
      "units": 0,
      "volume": 0
    }
  ],
  "total": 0,
  "totals": {
    "excluded": 0,
    "units": 0,
    "volume": 0,
    "volumePlausible": true
  },
  "truncated": true
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}

Listing offices the agent has closed through POST

Ranks the agent's CLOSED sales (status sold, a real sale price — rentals and lease listings excluded, duplicate records of one sale counted once) by this dimension. The same population `POST /v1/agents/{id}/sales` returns with `flatFilters.mlsStatus: "SLD"` and the agent analytics routes count. `side` narrows to the deals the agent was on that side of (`buyer` includes deals on both sides; `buyer` + `listing` = `any`).

Properties this agent has transacted on POST

Next Page