Skip to main content
GET
Los nueve niveles geográficos que maneja Atlas, con su nombre y su definición. Los entity_type_id de este catálogo (STATE, MUNICIPALITY, ZIPCODE…) son los valores que usas para filtrar en casi todos los demás endpoints.

Autorizaciones

Authorization
string
header
requerido

Token de autenticación. Formato requerido: Token tu-token (la palabra Token, un espacio y tu token). Solicita tu token escribiendo a contacto@tukanmx.com.

Parámetros de consulta

page
integer
predeterminado:1

Número de página

page_size
integer
predeterminado:100

Resultados por página

Búsqueda global en entity_type_id, name y name_en

Ejemplo:

"estado"

entity_type_id
string

ID exacto del tipo de entidad

Ejemplo:

"STATE"

name
string

Filtro por nombre en español (coincidencia parcial)

Ejemplo:

"municipio"

name_en
string

Filtro por nombre en inglés (coincidencia parcial)

Ejemplo:

"state"

Respuesta

Catálogo obtenido exitosamente

count
integer
Ejemplo:

9

page
integer
Ejemplo:

1

page_size
integer
Ejemplo:

100

results
object[]