v1
latestOpenAPI 3.1.02026-07-242200814.7 KBListar regiões
get/regions
Query parameters
showinteger
Número de itens na página de resultado.
cursorstring
Hash da próxima página.
region_idinteger
Filtrar pelo ID da região
namestring
Filtrar pelo nome da região
cep_tointeger
Filtrar pelo CEP inicial da região
cep_frominteger
Filtrar pelo CEP final da região
balanceinteger
Filtrar pelo balanço de oportunidades por região.
created_at_startstring date-time
Filtrar por regiões criadas a partir da data e hora informada.
created_at_endstring date-time
Filtrar por regiões criadas até a data e hora informada.
updated_at_startstring date-time
Filtrar por regiões atualizadas a partir da data e hora informada.
updated_at_endstring date-time
Filtrar por regiões atualizadas até a data e hora informada.
Response
200
Example response
{
"success": true,
"message": "OK",
"data": [
{
"id": 748,
"account_id": 748,
"region_id": 1,
"city_id": 1,
"last_user_id": 1,
"name": "Metropolis Region",
"cep_to": "22550000",
"cep_from": "22550000",
"created_at": "2015-10-05 00:00:00",
"updated_at": "2015-10-05 00:00:00",
"cities": {
"id": 5,
"uf": "RO",
"name": "Cerejeiras"
}
}
],
"meta": {
"cursor": {
"next": "eyJpZCI6MjUyODM0LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9"
}
}
}