---
title: "List Locations"
method: GET
path: "/restapi/v1.0/dictionary/location"
tags: ["Regional Settings"]
---

# List Locations

`GET /restapi/v1.0/dictionary/location`

Returns all available locations for a certain state.

## Query parameters

- `orderBy` 'Npa' | 'City'
- `page` integer
- `perPage` integer
- `stateId` string
- `withNxx` boolean

## Response `200`

Location list

- GetLocationListResponse
  - `uri` string, uri — Link to the location list resource
  - `records` LocationInfo[] — List of locations
    - `uri` string, uri — Canonical URI of a location
    - `areaCode` string — Area code of the location
    - `city` string — Official name of the city, belonging to the certain state
    - `npa` string — Area code of the location (3-digit usually), according to the NANP number format, that can be summarized as NPA-NXX-xxxx and covers Canada, the United States, parts of the Caribbean Sea, and some Atlantic and Pacific islands. See for details North American Numbering Plan
    - `nxx` string — Central office code of the location, according to the NANP number format, that can be summarized as NPA-NXX-xxxx and covers Canada, the United States, parts of the Caribbean Sea, and some Atlantic and Pacific islands. See for details North American Numbering Plan
    - `state` LocationStateInfo — Information on a state this location belongs to
      - `id` string — Internal identifier of a state
      - `uri` string, uri — Link to a state resource
  - `navigation` PageNavigationModel, required — Links to other pages of the current result set
    - `firstPage` PageNavigationUri
      - `uri` string, uri — Canonical URI to retrieve the particular page of the result set
    - `nextPage` PageNavigationUri
      - `uri` string, uri — Canonical URI to retrieve the particular page of the result set
    - `previousPage` PageNavigationUri
      - `uri` string, uri — Canonical URI to retrieve the particular page of the result set
    - `lastPage` PageNavigationUri
      - `uri` string, uri — Canonical URI to retrieve the particular page of the result set
  - `paging` EnumeratedPagingModel, required
    - `perPage` integer, required — Current page size, describes how many items are in each page. Matches "perPage" parameter from the request.
    - `page` integer — The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)
    - `pageStart` integer — The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty
    - `pageEnd` integer — The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty
    - `totalPages` integer — The total number of pages in a dataset. May be omitted for some resources due to performance reasons
    - `totalElements` integer — The total number of elements in a dataset. May be omitted for some resource due to performance reasons

---

[API](https://skmtc.net/ringcentral/apis/ringcentral-api.md) · [All operations](https://skmtc.net/ringcentral/apis/ringcentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ringcentral/ringcentral-api/revisions/8d602198ec97/schema)