Buscar ciudades — Restofy Docs

Descripción

Busca ciudades del catálogo oficial de un país para elegir la ubicación del negocio o de un cliente.

Detalles

Retorna las ciudades del país pedido con su región, ordenadas por nombre. Con un texto de búsqueda devuelve solo las ciudades cuyo nombre lo contiene, sin importar tildes ni mayúsculas. Cada ciudad se identifica por su país y su código oficial, que es lo que se guarda al elegirla. Es un catálogo fijo compartido por toda la plataforma y no requiere iniciar sesión.

Permisos requeridos

public

Request

Nombre	Tipo	Requerido	Reglas
countryCode	string	Sí	min:2 max:2
search	string	No	max:120

Paginación

defaultLimit	20
maxLimit	50
allowedSorts	name
defaultSort	name
defaultDir	asc

Respuesta

Campos que devuelve dentro de data. Nada fuera de esta lista sale en la respuesta.

Campo	Tipo	Descripción
municipalities	array	Ciudades del país que coinciden con la búsqueda
municipalities[].countryCode	string	País de la ciudad, código ISO de 2 letras
municipalities[].code	string	Código oficial de la ciudad
municipalities[].name	string	Nombre de la ciudad
municipalities[].stateRegionCode	string	Código oficial de la región
municipalities[].stateRegion	string	Nombre de la región
pagination	pagination	Página devuelta y total de resultados

Ejemplo de request

curl -X POST https://restofy.pro/api/municipalities/list-municipalities \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <accessToken>" \
  -d '{
    "countryCode": "string"
}'

Los valores son demo: reemplázalos por datos reales del negocio.

Ejemplo de respuesta

Actualizado: 2026-10-09T02:12:12Z

HTTP 200

Request

{
    "countryCode": "CO",
    "search": "Armenia"
}

Response

{
    "success": true,
    "message": "Ciudades",
    "data": {
        "municipalities": [
            {
                "countryCode": "CO",
                "code": "05059",
                "name": "Armenia",
                "stateRegionCode": "05",
                "stateRegion": "Antioquia"
            },
            {
                "countryCode": "CO",
                "code": "63001",
                "name": "Armenia",
                "stateRegionCode": "63",
                "stateRegion": "Quindío"
            }
        ],
        "pagination": {
            "page": 1,
            "limit": 20,
            "total": 2,
            "totalPages": 1,
            "hasNext": false,
            "hasPrev": false
        }
    }
}