v1

latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB

Regional Settings

List States

Returns all states of a certain country.

get/restapi/v1.0/dictionary/state

Query parameters

allCountriesboolean

If set to true then states of all countries are returned and countryId is ignored, even if specified. If the value is empty then the parameter is ignored

countryIdinteger

Internal identifier of a country

pageinteger

Indicates a page number to retrieve. Only positive number values are accepted

perPageinteger

Indicates a page size (number of items)

withPhoneNumbersboolean

If true the list of states with phone numbers available for buying is returned

Response

States list

uristring uri

Link to a states list resource

Example response

{
  "paging": {
    "perPage": 50,
    "page": 5,
    "pageEnd": 5,
    "totalPages": 25,
    "totalElements": 25
  }
}