List offices
simplyrets_list_officesThe brokerage office roster of the MLS feed, newest modification first. Needs the Offices API add-on on your SimplyRETS app (the demo credentials cannot use it). Pass count=true for the total. GET /offices.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Match office MLS id, main office MLS id, email (exact) or name (partial). | |
| name | No | Partial, case-insensitive office name. | |
| count | No | Also return the total number of matches. | |
| limit | No | Results per page, 1-100 (default 10). | |
| state | No | Partial, case-insensitive state. | |
| offset | No | Records to skip (the previous reply's next.offset). Do not combine with lastId. | |
| vendor | No | MLS vendor id; required on multi-MLS apps (simplyrets_get_account_info lists them). | |
| username | No | Feed username, when the credentials have several for the vendor. |