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

**GET /v1/Office/office-list**

<b>Sample request:</b>
```
GET /v1/office/office-list?mlsId=12345&isCoverage=true
            
```


## Servers
- https://api.lwolf.com/brokermetrics: https://api.lwolf.com/brokermetrics ()



## Parameters


### 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
### 200
Successfully returns the list of offices matching the specified criteria.

#### Body: application/json (array[object])
- **officeId** (string | null)

- **officeName** (string | null)

- **streetName1** (string | null)

- **city** (string | null)

- **zipCode** (string | null)

- **totalVolume** (number(double) | null)

- **agentCount** (number(double) | null)

- **agentTotalCount** (number(double) | null)

- **county** (string | null)

- **statusCode** (string | null)


### 400
One or more required parameters are missing or invalid.

#### Body: application/json (object)
- **type** (string | null)

- **title** (string | null)

- **status** (integer(int32) | null)

- **detail** (string | null)

- **instance** (string | null)


### 404
No offices were found that match the given criteria.

#### Body: application/json (object)
- **type** (string | null)

- **title** (string | null)

- **status** (integer(int32) | null)

- **detail** (string | null)

- **instance** (string | null)


### 500
An internal server error occurred while processing the request.


[Powered by Bump.sh](https://bump.sh)