Get Cities
API operation: Open the endpoint in Scalar
Use GET /countries/{country}/cities to list the cities associated with one country. The operation is City.findAll.
Requests may use an API key or bearer token. Role levels 0 and 1 can access this operation; results are scoped to the specified country and support pagination, ordering, filters, and relation expansion. See Cities special request for relation names.
Legacy SDK example
const response = await ordering.countries(countryId).cities().get()
The SDK helper name is cities(). SDK helpers can vary by version, so check the package and version you use.
OpenAPI reference
Operation: GET /countries/{country}/cities
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
country | integer | Yes | — |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
params | string | No | Comma-separated list of fields. It is intersected with the model’s $fillable; an empty or invalid list returns all fields. |
orderBy | string | No | Field to sort by, with - prefixed for descending order. Multiple fields can be chained with commas. |
where | string | No | JSON filter over the fields the model declares as filterable. Valid fields for each resource are exposed in its x-ordering-whereable schema extension. |
page | integer | No | Page number, starting at 1. Applies only to lists that return a pagination block. |
page_size | integer | No | Number of items per page. |
Responses
| Code | Description |
|---|---|
| 200 | OK (Envelope) |
| 400 | Bad Request (ErrorResponse) |
| 401 | Unauthorized |
| 404 | Not Found |
| 429 | Too Many Requests (ErrorResponse) |
| 500 | Internal Server Error (ErrorResponse) |
| 503 | Service Unavailable (ErrorResponse) |