---
title: "Listar clientes"
method: GET
path: "/v1/clientes"
tags: ["Clientes"]
---

# Listar clientes

`GET /v1/clientes`

Listar todos os clientes do estabelecimento.

## Query parameters

- `page` integer
- `pageSize` integer
- `nome` string
- `cpf` string
- `email` string
- `telefone` string
- `dataCadastroInicio` string, date-time
- `dataCadastroFim` string, date-time
- `dataAlteracaoCadastralInicio` string, date-time
- `dataAlteracaoCadastralFim` string, date-time
- `incluirDetalhes` boolean

## Headers

- `estabelecimentoId` string, required

## Response `200`

Success

- ClienteItemListDTOPaged
  - `page` integer
  - `pageSize` integer
  - `totalPages` integer
  - `totalRecords` integer
  - `data` ClienteItemListDTO[], nullable
    - `id` integer
    - `dataCadastro` string, nullable
    - `email` string, nullable
    - `nome` string, nullable
    - `telefones` TelefoneItemListDTO[], nullable
      - `ddi` string, nullable
      - `ddd` string, nullable
      - `telefone` string, nullable
    - `clienteDetalhes` ClienteDetailsDTO
      - `id` integer
      - `nome` string, nullable
      - `email` string, nullable
      - `cpf` string, nullable
      - `genero` string, nullable — M = Masculino, F = Feminino, N = Não-Binário, X = Não informado
      - `sexo` string, nullable — (OBSOLETO) Este campo está obsoleto e será removido no futuro. Retorna os mesmos dados do campo Genero
      - `observacoes` string, nullable
      - `codigoExterno` string, nullable
      - `telefone` string[], nullable
      - `pessoaFisicaId` integer
      - `preferencias` ClientePreferenciasDTO
        - `recebeSMSLembreteDeAgendamento` boolean
        - `recebeEmailLembreteDeAgendamento` boolean
        - `recebeSMSMarketing` boolean
        - `recebeEmailMarketing` boolean
      - `podeAgendarOnlineNoEstabelecimento` boolean
      - `dataCadastro` string, nullable
      - `dataUltimaAlteracao` string, nullable
      - `ativo` boolean
      - `dataNascimento` string, nullable
      - `endereco` ClienteEnderecoDTO
        - `logradouro` string, nullable
        - `numero` string, nullable
        - `complemento` string, nullable
        - `bairro` string, nullable
        - `cidade` string, nullable
        - `uf` string, nullable
        - `cep` string, nullable
      - `comoNosConheceu` ComoNosConheceuDTO
        - `id` integer
        - `descricao` string, nullable

---

[API](https://skmtc.net/trinks/apis/trinks-api.md) · [All operations](https://skmtc.net/trinks/apis/trinks-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/trinks/trinks-api/revisions/1b5b1e3825ef/schema)