Offices

Agents at an office

POST
/v1/offices/agents

Authorization

x-api-key<token>

In: header

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/offices/agents" \  -H "Content-Type: application/json" \  -d '{}'
{
  "cursor": "string",
  "data": [
    {
      "avgSoldPrice": 0,
      "buyerUnits": 0,
      "buyerVolume": 0,
      "city": "string",
      "dualUnits": 0,
      "dualVolume": 0,
      "email": "string",
      "firstName": "string",
      "fullName": "string",
      "id": "string",
      "lastName": "string",
      "licenseNumber": "string",
      "modelMatchId": "string",
      "office": "string",
      "phone": "string",
      "sellerUnits": 0,
      "sellerVolume": 0,
      "state": "string",
      "totalCompaniesWorkedWith": 0,
      "totalLendersWorkedWith": 0,
      "totalOriginatorsWorkedWith": 0,
      "units": 0,
      "volume": 0,
      "zip": "string"
    }
  ],
  "locationNormalizations": [
    {
      "candidates": [
        "string"
      ],
      "confidence": "normalized",
      "displayName": "Saint Louis, MO",
      "field": "city",
      "id": "city_mo_saint-louis",
      "normalized": "Saint Louis",
      "original": "St. Louis",
      "variants": [
        "string"
      ]
    }
  ],
  "total": 0
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}

Search real-estate offices with filters POST

NOT NMLS mortgage branches — use `/branches` for those. Returns office name, address, agent count, coordinates, and office-level production for the selected period. Default sort is by agent count descending. If you only need how many offices match and not the records themselves, send the same request body to `countOffices`.

Cancel a bulk-delivery job for originators DELETE

Cancels a queued or running originators delivery job. The job is marked `cancelled` immediately; the container running it notices on its next page boundary and stops. Because a delivery is billed once, at the end, **a cancelled job is never charged** — no credits are debited and there is nothing to refund. No partial file is written. Idempotent-ish: cancelling a job that has already finished (or was already cancelled) returns 409 and changes nothing. Poll `GET /v1/originators/bulk-delivery/{jobId}` for the settled state.