Retrieves a list of offices filtered by the specified MLS ID and coverage flag.

GET /v1/Office/office-list

Sample request:

GET /v1/office/office-list?mlsId=12345&isCoverage=true

Query parameters

  • mlsId string

    The unique identifier of the MLS provider used to filter offices.

  • isCoverage boolean

    Indicates whether to include only offices within the active coverage area. If set to true, only offices with active coverage will be returned.

Responses

GET /v1/Office/office-list
curl \
 --request GET 'https://api.lwolf.com/brokermetrics/v1/Office/office-list'
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (200)
<?xml version="1.0" encoding="UTF-8"?>
<root type="array">
  <root>
    <officeId>string</officeId>
    <officeName>string</officeName>
    <streetName1>string</streetName1>
    <city>string</city>
    <zipCode>string</zipCode>
    <totalVolume type="float">42.0</totalVolume>
    <agentCount type="float">42.0</agentCount>
    <agentTotalCount type="float">42.0</agentTotalCount>
    <county>string</county>
    <statusCode>string</statusCode>
  </root>
</root>
Response examples (200)
[
  {
    "officeId": "string",
    "officeName": "string",
    "streetName1": "string",
    "city": "string",
    "zipCode": "string",
    "totalVolume": 42.0,
    "agentCount": 42.0,
    "agentTotalCount": 42.0,
    "county": "string",
    "statusCode": "string"
  }
]
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400)
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <type>string</type>
  <title>string</title>
  <status type="integer">42</status>
  <detail>string</detail>
  <instance>string</instance>
</root>
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404)
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <type>string</type>
  <title>string</title>
  <status type="integer">42</status>
  <detail>string</detail>
  <instance>string</instance>
</root>
Response examples (404)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}