Locations

CMS Admin ships with the standard Philippine geographic hierarchy — regions, provinces, cities/municipalities, and barangays — used to populate address fields on case records, parties, and users.

These endpoints are read-only reference data (index only) and are referenced by code, not by numeric id — the Region and Province API responses don't include an id field at all. When you see region_code, province_code, or city_code on another resource (e.g. Case Records or Users), it points here by code.

The location hierarchy

Name
Region
Type
code, name, order_column
Description
Top-level administrative region, e.g. Region IV-A (CALABARZON).
Name
Province
Type
code, name, region_code, order_column
Description
Belongs to a region via region_code.
Name
City
Type
code, name, province_code, order_column
Description
A city or municipality, belongs to a province via province_code.
Name
Barangay
Type
code, name, city_code
Description
The smallest unit, belongs to a city via city_code.
Name
Country
Type
code, name
Description
Used on party/counsel address fields that support a country other than the Philippines.

GET/api/regions

List regions

Retrieve all regions, ordered by order_column.

Request

GET

/api/regions

curl https://your-domain.com/api/regions \
  -H "Accept: application/json" \
  -H "X-XSRF-TOKEN: {token}" \
  --cookie "cms_admin_session={session}"

Response

{
  "data": [
    {"name": "National Capital Region (NCR)", "code": "1300000000", "order_column": 1},
    {"name": "Region IV-A (CALABARZON)", "code": "1400000000", "order_column": 2}
  ]
}

GET/api/provinces

List provinces

Retrieve all provinces.

Optional attributes

Name
filter[region_code]
Type
string
Description
Filter provinces belonging to a specific region.

Request

GET

/api/provinces

curl -G https://your-domain.com/api/provinces \
  -H "Accept: application/json" \
  -H "X-XSRF-TOKEN: {token}" \
  --cookie "cms_admin_session={session}" \
  --data-urlencode "filter[region_code]=1300000000"

Response

{
  "data": [
    {"name": "Metro Manila", "code": "1374", "region_code": "1300000000", "order_column": 1}
  ]
}

GET/api/cities

List cities

Retrieve all cities/municipalities.

Optional attributes

Name
filter[province_code]
Type
string
Description
Filter cities belonging to a specific province.

Request

GET

/api/cities

curl -G https://your-domain.com/api/cities \
  -H "Accept: application/json" \
  -H "X-XSRF-TOKEN: {token}" \
  --cookie "cms_admin_session={session}" \
  --data-urlencode "filter[province_code]=1374"

Response

{
  "data": [
    {"name": "Quezon City", "code": "137404", "province_code": "1374"}
  ]
}

GET/api/countries

List countries

Retrieve all countries, for use on address fields that support a non-Philippine location.

Request

GET

/api/countries

curl https://your-domain.com/api/countries \
  -H "Accept: application/json" \
  -H "X-XSRF-TOKEN: {token}" \
  --cookie "cms_admin_session={session}"

Response

{
  "data": [
    {"name": "Philippines", "code": "PH"}
  ]
}