GET
List admin units

Query Parameters

level
string

province or ward; both levels when omitted. For public search preselect, call level=province with lat/lng and limit=1, then use data.units[0].code as province_code.

parent_code
string

Parent province code; with level=ward, returns that province's wards. For ward preselect, call level=ward with parent_code plus the same lat/lng and limit=1, then use data.units[0].code only when the ward exists in public filter options.

Maximum string length: 20
q
string

Case-insensitive name search (vi or en)

Maximum string length: 100
lat
number<double>

Browser latitude for nearest-ranking and public search location preselect; must be paired with lng

lng
number<double>

Browser longitude for nearest-ranking and public search location preselect; must be paired with lat

limit
integer<int64>

Page size 1-200 (default 100). Use limit=1 for nearest province/ward preselect.

Required range: 1 <= x <= 200

Response

Vietnam 2-tier (2025) administrative units, localized to Accept-Language. With lat/lng, results are nearest-ranked; public clients may use units[0].code as the dropdown preselect value.

data
object
required

Endpoint-specific response payload. See the referenced schema for the resource fields.

request_id
string
required

Request correlation identifier returned from X-Request-Id or generated by the API.

meta
object

Optional response metadata such as pagination limits, counts, or export context.