Offices

Get office by key with office-level production

GET
/v1/offices/{id}

Authorization

x-api-key<token>

In: header

Path Parameters

id*string

Office key (mm_office_key)

Query Parameters

period?string

Period for production metrics (default: last12Months)

Value in"2017" | "2018" | "2019" | "2020" | "2021" | "2022" | "2023" | "2024" | "2025" | "2026" | "last3Months" | "last6Months" | "last12Months" | "last14Months" | "last16Months" | "last18Months" | "last24Months" | "yearToDate" | "allTime"

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/offices/string"
{
  "data": {
    "activeListings": 0,
    "agentCount": 0,
    "avgListPrice": 0,
    "avgSalePrice": 0,
    "buyerUnits": 0,
    "buyerVolume": 0,
    "city": "string",
    "company": "string",
    "coordinates": {
      "lat": 0,
      "lon": 0
    },
    "country": "string",
    "dualUnits": 0,
    "dualVolume": 0,
    "id": "string",
    "lastCountedAt": "string",
    "locationType": "string",
    "sellerUnits": 0,
    "sellerVolume": 0,
    "state": "string",
    "street": "string",
    "teamSize": 0,
    "units": 0,
    "volume": 0,
    "zip": "string",
    "email": "string",
    "fullAddress": "string",
    "number": "string",
    "phone": "string",
    "totalListPriceActive": 0
  }
}
{
  "error": "string"
}