Offices

Agents at an office

postapi.modelmatch.com/v1/offices/agents

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

citystring

Narrow agent matches to this city (exact, lowercase).

companyNamestring

Office name to match against ModelMatch.AgentOffices.OfficeName (fuzzy). Required when officeId is omitted.

officeIdstring

Office key (mm_office_key). When set, the office is fetched first to resolve its name / city / state.

paginationobject

Show child attributes

cursorstring

Opaque cursor from previous response for next page

sizeinteger

Page size (1-100, default 25)

sortobject[]

Show child attributes

fieldenumrequired

Options:officecitystatezipvolumeunitsavgSalePricebuyerVolumebuyerUnitssellerVolumesellerUnitsdualVolumedualUnitsnamefirstNamelastNameemailproducersOnlymortgagedBuyerVolumemortgagedBuyerUnitsmortgagedSellerVolumemortgagedSellerUnitsmortgagedDualVolumemortgagedDualUnits+4 more

orderenum

Options:ascdesc

statestring

Narrow agent matches to this state (exact, lowercase).

Responses

200objectPaginated list of agents at the office

Show attributes

cursorstring

dataobject[]required

Show child attributes

avgSoldPricenumber | null

buyerUnitsnumber | null

buyerVolumenumber | null

citystring | null

contactsobject

Show child attributes

emailsstring[]required

phonesobject[]required

socialLinksstring[]required

websitestring | nullrequired

dualUnitsnumber | null

dualVolumenumber | null

emailstring | null

firstNamestring | null

fullNamestring | null

idstringrequired

Document ID

lastNamestring | null

licenseNumberstring | null

loanMixobject[]

Show child attributes

keystringrequired

volumenumberrequired

modelMatchIdstring | null

officestring | null

officesobject[]

Show child attributes

citystring | nullrequired

keystring | nullrequired

lastTransactionDatestring | nullrequired

latnumber | nullrequired

lonnumber | nullrequired

namestring | nullrequired

statestring | nullrequired

streetstring | nullrequired

transactionsnumber | nullrequired

zipstring | nullrequired

phonestring | null

sellerUnitsnumber | null

sellerVolumenumber | null

statestring | null

totalCompaniesWorkedWithnumber | null

totalLendersWorkedWithnumber | null

totalOriginatorsWorkedWithnumber | null

unitsnumber | null

volumenumber | null

zipstring | null

locationNormalizationsobject[]

How each location filter value resolved. Present when a city/county/state/zip filter was supplied.

Show child attributes

candidatesstring[]

Location ids matching an ambiguous name, ranked. Use instantSearch or suggestLocations to pick one.

confidenceenumrequired

"exact" — matched a dictionary entry as written. "normalized" — resolved to a different spelling or merged several candidates. "fallback" — NOT resolved; the raw value was passed through, so a zero result means the name was not recognized rather than empty.

Options:exactnormalizedfallback

displayNamestringrequired

fieldstringrequired

The filter key this applies to

idstring

Resolved location id — pass this back for an exact filter

normalizedstringrequired

originalstringrequired

variantsstring[]

Spellings actually queried against the index

totalnumberrequired

400objectValidation error

401objectUnauthorized

403objectForbidden (authenticated, but missing required context — e.g. no active organization)

404objectNot found

413objectResponse payload too large — detail endpoint capped to fit Lambda response limits

503objectSearch timed out or the cluster is overloaded — retry after `Retry-After` seconds.

curl -X POST "https://api.modelmatch.com/v1/offices/agents" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "city": "<string>",
    "companyName": "<string>",
    "officeId": "<string>",
    "state": "<string>"
  }'

import { createClient } from "@model-match/api";

const client = createClient({ apiKey: process.env.MODEL_MATCH_API_KEY });

const { data, error } = await client.offices.agents({
  body: {
    city: "<string>",
    companyName: "<string>",
    officeId: "<string>",
    state: "<string>"
  }
});

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/offices/agents",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "city": "<string>",
        "companyName": "<string>",
        "officeId": "<string>",
        "state": "<string>"
    },
)
data = res.json()

200 response

{
  "cursor": "<string>",
  "data": [
    {
      "avgSoldPrice": 123.45,
      "buyerUnits": 123.45,
      "buyerVolume": 123.45,
      "city": "<string>",
      "contacts": {
        "emails": [
          "<string>"
        ],
        "phones": [
          {
            "number": "<string>",
            "type": "mobile"
          }
        ],
        "socialLinks": [
          "<string>"
        ],
        "website": "<string>"
      },
      "dualUnits": 123.45,
      "dualVolume": 123.45,
      "email": "<string>",
      "firstName": "<string>",
      "fullName": "<string>",
      "id": "<string>",
      "lastName": "<string>",
      "licenseNumber": "<string>",
      "loanMix": [
        {
          "key": "<string>",
          "volume": 123.45
        }
      ],
      "modelMatchId": "<string>",
      "office": "<string>",
      "offices": [
        {
          "city": "<string>",
          "key": "<string>",
          "lastTransactionDate": "<string>",
          "lat": 123.45,
          "lon": 123.45,
          "name": "<string>",
          "state": "<string>",
          "street": "<string>",
          "transactions": 123.45,
          "zip": "<string>"
        }
      ],
      "phone": "<string>",
      "sellerUnits": 123.45,
      "sellerVolume": 123.45
    }
  ],
  "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": 123.45
}