Regional Settings
List Locations
Returns all available locations for a certain state.
get/restapi/v1.0/dictionary/location
Request
- Base URLhttps://platform.ringcentral.com
- AuthOAuth 2Authorization codehttps://platform.ringcentral.com/restapi/oauth/authorizeToken URLhttps://platform.ringcentral.com/restapi/oauth/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
orderBy'Npa' | 'City'
Sorts results by the property specified
pageinteger
Indicates a page number to retrieve. Only positive number values are accepted
perPageinteger
Indicates a page size (number of items)
stateIdstring
Internal identifier of a state
withNxxboolean
Specifies if nxx codes are returned
Response
Location list
Example response
{
"paging": {
"perPage": 50,
"page": 5,
"pageEnd": 5,
"totalPages": 25,
"totalElements": 25
}
}Changes
No recorded changes to this operation across all 1 revision of this API.