Skip to main content
GET
Listar clientes
Este endpoint suporta paginação por scroll_id, ideal para navegar grandes volumes de dados sem perder a consistência da ordenação. Consulte a documentação completa para saber como funciona o ciclo de paginação.

Authorizations

User-Token
string
header
required
User-Secret-Key
string
header
required

Path Parameters

alias
string
required

Alias da loja

Query Parameters

include
enum<string>[]

Incluir relacionamentos adicionais

Available options:
stats,
addresses,
cluster,
spreadsheet,
search,
deletion_request
filters
Filtros por Compra, Campanha e Origem · object

Filtros por campanha, origem, datas e status Mapeia os filtros disponíveis para pesquisa baseada em campanhas, datas de compra/criação, origem e status.

Response

Lista de clientes retornada com sucesso

Representa uma paginação com meta

data
Customer · object[]
meta
object