Skip to navigation
API ReferenceCustomers

List customers

Lista clientes. Atributos do cliente são dinâmicos (definidos pelos formulários de cliente da conta).

Suporta os parâmetros universais JSON:API (paginação, ordenação, include, sparse fieldsets) — veja as convenções.

Authentication

AuthorizationBearer
Token de API da conta do tenant.

Query parameters

filter[created_at]stringOptional

datetime, opcional. Clientes criados no intervalo.

Ex: filter[created_at]=2018-06-01T00:00:00.000Z,2018-06-01T23:59:59.999Z

filter[updated_at]stringOptional

datetime, opcional. Clientes atualizados no intervalo.

Ex: filter[updated_at]=2018-06-01T00:00:00.000Z,2018-06-01T23:59:59.999Z

filter[attributes]stringOptional

string, opcional. Clientes cujos atributos indexados contenham o valor.

Ex: filter[attributes]=Fulano

sortstringOptional

Ordenável por: created_at, updated_at.

page[limit]stringOptional

integer, opcional. Quantidade máxima de itens por página.

page[offset]stringOptional

integer, opcional. Deslocamento (quantos itens pular) para paginação.

Response

Sucesso.