Model MatchHelp

Agents

Get agent by ID

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

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

idstringrequired

Agent document ID

Query parameters

periodenum

Period for volume/units (default: last12Months)

Options:2017201820192020202120222023202420252026last3Monthslast6Monthslast12Monthslast14Monthslast16Monthslast18Monthslast24MonthsyearToDateallTime

Responses

200objectAgent detail
Show attributes
dataobjectrequired
Show child attributes
avgSoldPricenumber | null
buyerUnitsnumber | null
buyerVolumenumber | null
citystring | null
dualUnitsnumber | null
dualVolumenumber | null
emailstring | null
firstNamestring | null
fullNamestring | null
idstringrequired

Document ID

lastNamestring | null
licenseNumberstring | null
modelMatchIdstring | null
officestring | null
phonestring | null
sellerUnitsnumber | null
sellerVolumenumber | null
statestring | null
totalCompaniesWorkedWithnumber | null
totalLendersWorkedWithnumber | null
totalOriginatorsWorkedWithnumber | null
unitsnumber | null
volumenumber | null
zipstring | null
akasobject[]

Name variations recorded on past transactions.

Show child attributes
lastTransactionDatestring | nullrequired
namestringrequired
transactionsnumber | nullrequired
contactHistoryobject[]

Every email and phone on the record with how often and how recently it was seen (contacts without the counters).

Show child attributes
lastTransactionDatestring | nullrequired
transactionsnumber | nullrequired
typeenumrequired
Options:emailmobiledirectoffice
valuestringrequired
contactsobject
Show child attributes
emailsstring[]required
phonesobject[]required
socialLinksstring[]required
websitestring | nullrequired
licensesobject[] | null
Show child attributes
expirationDatestring | null
numberstring | null
statestring | null
typestring | null
linkedProfileCountnumber | null

Total consolidated records for this agent, before the 20-entry cap applied to linkedProfiles.

linkedProfilesobject[] | null

Additional records consolidated into this agent — the SAME person as captured by different data sources, not teammates or a team roster. Useful for the alternate contact details and the transaction window each record carries. Ordered by transaction count, highest first, and capped at 20 entries; linkedProfileCount is the uncapped total.

Show child attributes
emailstring | null
firstTransactionDatestring | null
lastTransactionDatestring | null
namestring | null
officePhonestring | null
phonestring | null
transactionsnumber | null

Transactions observed on this record.

officesobject[]
Show child attributes
citystring | nullrequired
keystring | nullrequired
lastTransactionDatestring | nullrequired
latnumber | nullrequired
lonnumber | nullrequired
namestring | nullrequired
statestring | nullrequired
streetstring | nullrequired
transactionsnumber | nullrequired
zipstring | nullrequired
scorednull
404objectAgent not found
413objectResponse payload too large