Agents at an office
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`.
Count originators matching filters POST
Return the exact number of originators matching the given filters. Accepts the same request body as `listOriginators` (pagination and sort are ignored). Use this when you only need a total; to get the matching originators themselves, send the same request body to `listOriginators`.