Locations
List locations
Retrieve a paginated list of locations, sorted by member count (descending).
get/locations
Request
- Base URLhttps://api.commonroom.io/api/v2
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
locationType'city' | 'country' | 'country_region' | 'world_region' required
The granularity of locations to return (required)
limitinteger
The maximum number of locations to return per page
cursorstring
Pagination cursor from a previous response
colsstring
Comma-separated list of meta columns. The meta column recordCount can be requested to return the total number of matching locations in meta.recordCount.
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.