Skip to content

Listar o buscar ciudades

GET
/cities

Busca ciudades en la base de datos. Permite filtros por nombre o obtener una ciudad específica por código DANE. Utilizado principalmente para autocompletar y selección de ubicaciones.

Authorizations

bearerAuth

JWT token de autenticación. Utilice este esquema para autenticar solicitudes con un token JWT.

TypeHTTP (bearer)

Parameters

Query Parameters

q

Término de búsqueda para filtrar ciudades por nombre (mínimo 3 caracteres)

Typestring
Examplebogot
minLength3
dane

Código DANE específico para obtener una ciudad exacta

Typestring
Example11001
pattern^[0-9]{5}$

Responses

Ciudades obtenidas exitosamente
application/json
JSON
{
"data": {
"cities": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Bogotá",
"daneCode": 11001,
"lat": "4.6097",
"long": "-74.0817",
"state": {
"id": "123e4567-e89b-12d3-a456-426614174001",
"name": "Cundinamarca",
"daneCode": 11
},
"province": {
"id": "123e4567-e89b-12d3-a456-426614174002",
"name": "Sabana Centro"
},
"createdAt": "2024-01-15T10:30:00Z"
},
{
"id": "123e4567-e89b-12d3-a456-426614174005",
"name": "Bosa",
"daneCode": 11911,
"lat": "4.6183",
"long": "-74.1833",
"state": {
"id": "123e4567-e89b-12d3-a456-426614174001",
"name": "Cundinamarca",
"daneCode": 11
},
"province": {
"id": "123e4567-e89b-12d3-a456-426614174002",
"name": "Sabana Centro"
},
"createdAt": "2024-01-15T10:30:00Z"
}
]
}
}

Playground

Server
Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI