Territory
List cities
Lists cities with their county, state and country and the number of properties, brands and agencies that have an office there. Filters, ordering and paging come from the query string.
get/api/city
Request
- Base URLhttps://api.sponsorunited.com (the document declares no server; this is the origin it was published from)
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
searchstring
Part of the city name
country_idstring
One country id, or a JSON array of ids
state_idstring
One state id, or a JSON array of ids
county_idstring
One county id, or a JSON array of ids
order_by'id' | 'name' | 'county_id' | 'county_name' | 'state_id' | 'state_name' | 'country_id' | 'country_name' | 'locations_count'
order'asc' | 'desc'
limitinteger
paginateinteger
Page size; when given the answer is a paginated list
Response
A list of cities, or a paginated list when paginate is given
Changes
No recorded changes to this operation across all 2 revisions of this API.