Lista Estados

GET/v1/estados

Retorna uma lista paginada com os Estados da união. - O resultado da consulta é paginado com limite de 200 itens por pagina. - Cada consulta consome 1 crédito. - Disponível somente nos planos pagos.

URL base: https://api.nextapi.com.br. Autenticação: Authorization: Bearer SEU_TOKEN.

Exemplo de requisição

Substitua os valores de exemplo pelos dados da sua consulta. O código não executa uma chamada automaticamente.

cURL

curl --request GET 'https://api.nextapi.com.br/v1/estados' \
  --header 'Authorization: Bearer SEU_TOKEN' \
  --header 'Accept: application/json'

Parâmetros

Nome	Local	Obrigatório	Tipo / regras	Descrição
`page`	query	Não	`integer (int32)`	Número da página (padrão: 1)
`pageSize`	query	Não	`integer (int32)`	Quantidade de itens por página (máx: 200)

Respostas HTTP

Status	Descrição	Formato JSON
`200`	Operação realizada com sucesso	EstadoItemResponsePagedResult
`400`	Erro nos parametros informados na requisição	IErrorCodeModel
`405`	Falta de créditos para realizar a consulta	IErrorCodeModel
`500`	Erro ao processar a requisição	objeto

Envie Accept: application/json para solicitar JSON. Autenticação e limites também podem gerar erros antes da execução da operação. Consulte o guia de tratamento de erros.

Resposta de sucesso

Exemplo estrutural gerado do schema: os valores abaixo são ilustrativos, não representam uma consulta real. Campos anuláveis podem retornar null.

JSON · estrutura ilustrativa

{
  "page": 0,
  "pageSize": 0,
  "total": 0,
  "items": [
    {
      "uf": "string",
      "nome": "string",
      "totalEstabelecimentos": 0
    }
  ]
}

Campos da resposta

Modelo: EstadoItemResponsePagedResult

EstadoItemResponsePagedResult

Campo	Tipo	Obrigatório	Descrição / regras
`page`	`integer (int32)`	Não marcado no contrato	—
`pageSize`	`integer (int32)`	Não marcado no contrato	—
`total`	`integer (int64)`	Não marcado no contrato	—
`items`	`EstadoItemResponse[]`	Não marcado no contrato	—

EstadoItemResponse

Campo	Tipo	Obrigatório	Descrição / regras
`uf`	`string \| null`	Sim	—
`nome`	`string \| null`	Não marcado no contrato	—
`totalEstabelecimentos`	`integer (int64) \| null`	Não marcado no contrato	—

Contrato desta operação

OpenAPI · JSON

{
  "tags": [
    "Estados"
  ],
  "summary": "Lista Estados",
  "description": "Retorna uma lista paginada com os Estados da união.\n\n- O resultado da consulta é paginado com limite de 200 itens por pagina.\n- Cada consulta consome 1 crédito.\n- Disponível somente nos planos pagos.",
  "parameters": [
    {
      "name": "page",
      "in": "query",
      "description": "Número da página (padrão: 1)",
      "schema": {
        "type": "integer",
        "format": "int32"
      }
    },
    {
      "name": "pageSize",
      "in": "query",
      "description": "Quantidade de itens por página (máx: 200)",
      "schema": {
        "type": "integer",
        "format": "int32"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Operação realizada com sucesso",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/EstadoItemResponsePagedResult"
          }
        },
        "text/xml": {
          "schema": {
            "$ref": "#/components/schemas/EstadoItemResponsePagedResult"
          }
        }
      }
    },
    "400": {
      "description": "Erro nos parametros informados na requisição",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/IErrorCodeModel"
          }
        },
        "text/xml": {
          "schema": {
            "$ref": "#/components/schemas/IErrorCodeModel"
          }
        }
      }
    },
    "405": {
      "description": "Falta de créditos para realizar a consulta",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/IErrorCodeModel"
          }
        },
        "text/xml": {
          "schema": {
            "$ref": "#/components/schemas/IErrorCodeModel"
          }
        }
      }
    },
    "500": {
      "description": "Erro ao processar a requisição",
      "content": {
        "application/json": {
          "schema": {}
        },
        "text/xml": {
          "schema": {}
        }
      }
    }
  },
  "method": "GET",
  "path": "/v1/estados",
  "slug": "get-v1-estados"
}