Offices

Office-name typeahead (distinct names with agent totals)

postapi.modelmatch.com/v1/offices/names

Distinct real-estate office names starting with query, each with the agents and offices behind that name across all its offices — the picker for filters that match by office name (listOffices company, listAgents currentOffice). To find one office, use instantSearch or listOffices instead.

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

limitinteger

Max names (default 20).

querystringrequired

The start of an office name (≥ 2 chars), matched as a phrase prefix on the name's words.

Responses

200objectMatching office names

Show attributes

dataobject[]required

Show child attributes

agentCountnumberrequired

Agents across every office with this name

namestringrequired

The office name as stored (lowercase) — pass it back as company on listOffices, or as currentOffice / office on listAgents.

officeCountnumberrequired

Offices with this name

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/names" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "<string>",
    "limit": 50
  }'

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

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

const { data, error } = await client.offices.suggestOfficeNames({
  body: {
    query: "<string>",
    limit: 50
  }
});

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/offices/names",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "query": "<string>",
        "limit": 50
    },
)
data = res.json()

200 response

{
  "data": [
    {
      "agentCount": 123.45,
      "name": "<string>",
      "officeCount": 123.45
    }
  ]
}