Listar Estados

Descrição

Retorna todos os estados do país associado ao usuário autenticado. Além das informações do estado (ID, nome e sigla), a resposta também inclui a hierarquia completa de cidades pertencentes a cada estado e, dentro de cada cidade, a lista de bairros. Esse endpoint pode ser útil para cadastros, filtros e qualquer funcionalidade que exija dados geográficos estruturados.

OBS. Disponível para uso com chave de acesso de filial e também com chave de acesso de ADM Geral.

🔑 Parâmetros de Consulta

Não requer parâmetros. A lista de estados é retornada automaticamente com base no país do usuário autenticado.

📤 Estrutura da Resposta

A resposta retorna a lista de estados, contendo a hierarquia completa de cidades e bairros associados.

Campo	Tipo	Descrição
idState	int32	Identificador do estado.
name	string	Nome do estado.
abbreviation	string	Sigla do estado (ex.: SP, RJ).
idCountry	int32	Identificador do país ao qual o estado pertence.
cities	array/	Lista de cidades pertencentes ao estado. Veja a estrutura abaixo.

🧩 Estrutura do objeto cities

Campo	Tipo	Descrição
idCity	int32	Identificador da cidade.
idState	int32	Identificador do estado ao qual a cidade pertence.
name	string	Nome da cidade.
neighborhoods	array/	Lista de bairros pertencentes à cidade. Veja a estrutura abaixo.

🧩 Estrutura do objeto neighborhoods

Campo	Tipo	Descrição
idNeighborhood	int32	Identificador do bairro.
idCity	int32	Identificador da cidade à qual o bairro pertence.
description	string	Nome ou descrição do bairro.