Get Vietnam Provinces (Cities)

GET

/reference/cities

Retrieve the list of Vietnamese provinces/cities for address forms. Only applicable when the selected country is Vietnam (code = VN).

Scope Required: properties:read

Use Cases:

• Populate the city/province select dropdown after user selects country = VN
• Validate city code before fetching wards

Important Notes:

• Vietnam provinces only — use this endpoint only when country = VN
• Results are sorted alphabetically by name
• The code field (TMSCode) is used to fetch wards via /reference/cities/{city_code}/wards
• DB stores the province name (not the code) in the city field
• Results are cached permanently (static data)

Authorizations

• http

Responses

200

object

success

required

boolean

data

required

Array<object>

object

code

required

string

name

required

string