---
title: "Listar estados"
method: GET
path: "/api/promotions/customers/states"
tags: ["Admin API · Promoções"]
---

# Listar estados

`GET /api/promotions/customers/states`

## Request

- Base URL: `https://sualoja.commerce-wake.tech`
- URL: `https://sualoja.commerce-wake.tech/api/promotions/customers/states`
- Auth: HTTP bearer

Lista os estados brasileiros. Use `stateId` na condição de estado e `abbreviation` no filtro
`states` da busca de clientes.
            
Permissão: **Cadastro de promoções — visualização**.

## Headers

- `x-api-version` '2.0', required

## Response `200`

Estados em `data`.

- ListingResponseDTOGetCustomersStatesQueryDTO
  - `data` GetCustomersStatesQueryDTO[], nullable: Itens da página.
    - `stateId` integer: ID do estado. Use na condição de estado.
    - `name` string, nullable: Nome do estado.
    - `abbreviation` string, nullable: UF. Use no filtro `states` da busca de clientes.
  - `total` integer, nullable: Total informado pela listagem. Nas rotas de apoio de promoções é a quantidade de itens desta página; o total geral fica em `totalGeneral`.
  - `totalGeneral` integer, nullable: Total de itens que atendem aos filtros, em todas as páginas.
  - `totalActive` integer, nullable: Total de itens ativos, quando a listagem informa.
  - `totalInactive` integer, nullable: Total de itens inativos, quando a listagem informa.
  - `totalArchived` integer, nullable: Total de itens arquivados, quando a listagem informa.
  - `limit` integer, nullable: Tamanho de página usado.
  - `page` integer, nullable: Página retornada, começando em 1.
  - `totalPage` integer, nullable: Quantidade de páginas, quando a listagem informa.
  - `message` string, nullable: Observação opcional sobre a listagem (por exemplo, por que veio vazia). Omitida quando nula.

## Other responses

- `400`: Requisição inválida, incluindo a falta do header x-api-version. O motivo vem em details.
- `401`: Token ausente, inválido ou expirado (SESSION_INVALID), ou sem a permissão exigida (UNAUTHORIZED).
- `500`: Erro inesperado. Tente de novo; se persistir, contate o suporte com o traceId.

---

[API](https://skmtc.dev/fbits/apis/admin-api.md) - [All operations](https://skmtc.dev/fbits/apis/admin-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fbits/apis/admin-api/revisions/a37bfd1b0bf3?raw)