Cities

Developing

GET

/v1/address/cities/{province_id}

Retrieves a paginated list of cities/municipalities within a specified province. Results include city codes and hierarchical relationship data.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

province_id

integer

required

ID of the province

Example:

Query Params

start

integer

optional

Starting index for pagination (default: 0)

Example:

limit

integer

optional

Number of records per page (default: 10)

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

total

integer

required

data

array [object {4}]

required

name

string

required

City name

code

string

optional

City code

integer

required

City ID

province_id

integer

required

Reference to province

Example

{
    "total": 6,
    "data": [
        {
            "name": "JAKARTA BARAT",
            "code": "JKTB",
            "id": 37,
            "province_id": 1
        },
        {
            "name": "JAKARTA PUSAT",
            "code": "JKTP",
            "id": 38,
            "province_id": 1
        },
        {
            "name": "JAKARTA SELATAN",
            "code": "JKTS",
            "id": 40,
            "province_id": 1
        },
        {
            "name": "JAKARTA TIMUR",
            "code": "JKTT",
            "id": 39,
            "province_id": 1
        },
        {
            "name": "JAKARTA UTARA",
            "code": "JKTU",
            "id": 36,
            "province_id": 1
        },
        {
            "name": "KEPULAUAN SERIBU",
            "code": "KSRB",
            "id": 35,
            "province_id": 1
        }
    ]
}

Provinces

Districts