Listar clientes
Retorna todos os clientes.
Os itens são retornados e ordenados por data de criação, com os itens mais recentes primeiro.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Um filtro com base no campo id
do cliente. O valor deve ser uma string ou uma lista separada por vírgula.
Expande as referências.
Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.
Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o padrão é 10.
Um filtro com base no campo document
. O valor deve ser uma string ou uma lista separada por vírgula
Um filtro com base no campo email
. O valor deve ser uma string ou uma lista separada por vírgula
Um filtro com base no campo phone
. O valor deve ser uma string ou uma lista separada por vírgula
Um cursor para uso na paginação. starting_after
é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo
, sua chamada subsequente poderá incluir starting_after=obj_foo
para buscar a próxima página da lista.
Um cursor para uso na paginação. starting_after
é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo
, sua chamada subsequente poderá incluir starting_after=obj_foo
para buscar a próxima página da lista.
Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.
Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.
Response
Uma lista de clientes.
Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter
.
Uma lista de clientes