Skip to main content
GET
/
cities
Listado de ciudades
curl --request GET \
  --url https://api.onepay.la/v1/cities \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 149,
      "name": "Bogotá",
      "state": {
        "id": 11,
        "name": "Bogotá D.C."
      }
    },
    {
      "id": 312,
      "name": "Medellín",
      "state": {
        "id": 5,
        "name": "Antioquia"
      }
    }
  ],
  "current_page": 1,
  "from": 1,
  "last_page": 74,
  "per_page": 15,
  "to": 15,
  "total": 1102
}

Documentation Index

Fetch the complete documentation index at: https://docs.onepay.la/llms.txt

Use this file to discover all available pages before exploring further.

Usado en crear empresa

El id de cada ciudad es el valor que se envía como city_id al crear una empresa.

​
Query Parameters

​
filter[name]
string
Filtra ciudades por nombre (búsqueda parcial, case-insensitive).
​
filter[state_id]
integer
Filtra ciudades por departamento. Consulta el endpoint de departamentos para obtener los IDs válidos.
​
sort
string
default:"name"
Ordenamiento por nombre. Usa name para ascendente y -name para descendente.
​
per_page
integer
default:"15"
Cantidad de resultados por página.
​
page
integer
default:"1"
Número de página para paginación.

​
Ejemplos de uso

curl https://api.onepay.la/v1/cities \
  -X GET \
  -H "Authorization: Bearer sk_test_xxx"
Con filtro por nombre:
curl "https://api.onepay.la/v1/cities?filter[name]=bog" \
  -X GET \
  -H "Authorization: Bearer sk_test_xxx"

​
Response

​
data
array
Lista de ciudades.
​
current_page
integer
Página actual.
​
from
integer
Índice del primer registro en la página actual.
​
last_page
integer
Última página disponible.
​
per_page
integer
Cantidad de registros por página.
​
to
integer
Índice del último registro en la página actual.
​
total
integer
Total de ciudades.

​
Ejemplo de respuesta

{
  "data": [
    {
      "id": 149,
      "name": "Bogotá",
      "state": {
        "id": 11,
        "name": "Bogotá D.C."
      }
    },
    {
      "id": 312,
      "name": "Medellín",
      "state": {
        "id": 5,
        "name": "Antioquia"
      }
    }
  ],
  "current_page": 1,
  "from": 1,
  "last_page": 74,
  "per_page": 15,
  "to": 15,
  "total": 1102
}