Skip to main content
GET
Listar clientes do segmento

Autorizações

Authorization
string
header
obrigatório

API key criada nas configurações da organização.

Parâmetros de caminho

segment_id
string
obrigatório

ID público do segmento.

Pattern: ^seg_[A-Za-z0-9_-]+$

Parâmetros de consulta

limit
integer
padrão:25

Quantidade máxima de itens por página.

Intervalo obrigatório: 1 <= x <= 100
starting_after
string

ID do último cliente da página anterior.

Pattern: ^cus_[A-Za-z0-9_-]+$
email
string<email>

E-mail exato do cliente.

phone
string

Telefone do cliente, com 3 a 32 caracteres.

Required string length: 3 - 32
tag_id
string

Filtra clientes por tag.

Pattern: ^tag_[A-Za-z0-9_-]+$
is_subscribed
boolean

Filtra clientes pelo estado da assinatura.

created_since
string<date-time>

Inclui itens criados a partir deste instante, inclusive.

created_until
string<date-time>

Inclui itens criados até este instante, inclusive.

updated_since
string<date-time>

Inclui clientes atualizados a partir deste instante, inclusive.

q
string

Texto de busca, com até 256 caracteres.

Required string length: 1 - 256
sort
enum<string>
padrão:updated

Ordena por atualização ou valor total comprado.

Opções disponíveis:
updated,
total_spent

Resposta

Página de clientes.

has_more
boolean
obrigatório

Indica se existe uma próxima página.

data
object[]
obrigatório