Model MatchHelp

Offices

Get office by key with office-level production

getapi.modelmatch.com/v1/offices/{id}

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

idstringrequired

Office key (mm_office_key)

Query parameters

periodenum

Period for production metrics (default: last12Months)

Options:2017201820192020202120222023202420252026last3Monthslast6Monthslast12Monthslast14Monthslast16Monthslast18Monthslast24MonthsyearToDateallTime

Responses

200objectOffice detail
Show attributes
dataobjectrequired
Show child attributes
activeListingsnumber | null
agentCountnumber | null

Number of agents at this office

avgListPricenumber | null
avgSalePricenumber | null
buyerUnitsnumber | null
buyerVolumenumber | null
citystring | null

City (stored lowercase on the source index)

companystring | null
coordinatesobject | null
Show child attributes
latnumberrequired
lonnumberrequired
countrystring | null
dualUnitsnumber | null
dualVolumenumber | null
emailstring | null

Office email (list rows since 2026-10-15; was detail-only)

idstringrequired

Office key (mm_office_key)

lastCountedAtstring | null
locationTypestring | null
phonestring | null

Office phone (list rows since 2026-10-15; was detail-only)

sellerUnitsnumber | null
sellerVolumenumber | null
statestring | null

State abbreviation (stored lowercase on the source index)

streetstring | null
teamSizenumber | null
topOriginatorobject | null

Present only when the request set includeTopOriginator: the loan officer on the most of this office's BUYER-side deals in the period (ties → more volume, then lower NMLS id), named from the LO's own profile with their current employer. null when no buyer-side deal had a tracked LO.

Show child attributes
buyerUnitsnumberrequired
buyerVolumenumberrequired
companyobject | nullrequired
namestringrequired
nmlsIdstringrequired
unitsnumber | null
volumenumber | null
zipstring | null
fullAddressstring | null
numberstring | null
totalListPriceActivenumber | null

Total list price of active listings at this office

404objectOffice not found