Skip to main content
GET
Listar clientes del segmento

Autorizaciones

Authorization
string
header
requerido

Clave API creada en la configuración de la organización.

Parámetros de ruta

segment_id
string
requerido

ID público del segmento.

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

Parámetros de consulta

limit
integer
predeterminado:25

Cantidad máxima de elementos por página.

Rango requerido: 1 <= x <= 100
starting_after
string

ID del último cliente de la página anterior.

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

Email exacto del cliente.

phone
string

Teléfono del cliente, de 3 a 32 caracteres.

Required string length: 3 - 32
tag_id
string

Filtra clientes por etiqueta.

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

Filtra clientes por el estado de la suscripción.

created_since
string<date-time>

Incluye elementos creados desde este instante, inclusive.

created_until
string<date-time>

Incluye elementos creados hasta este instante, inclusive.

updated_since
string<date-time>

Incluye clientes actualizados desde este instante, inclusive.

q
string

Texto de búsqueda, con hasta 256 caracteres.

Required string length: 1 - 256
sort
enum<string>
predeterminado:updated

Ordena por actualización o valor total comprado.

Opciones disponibles:
updated,
total_spent

Respuesta

Página de clientes.

has_more
boolean
requerido

Indica si existe una página siguiente.

data
object[]
requerido