v1
latestOpenAPI 3.0.32026-07-24113102327.9 KBcustomers
Retorna uma lista de clientes.
Utilize este método para listar os clientes associados à sua conta na Vindi. Leia a documentação sobre paginação e filtros de busca.
Atributos para busca
<code>id</code>, <code>name</code>, <code>status</code>, <code>code</code>, <code>email</code>, <code>registry_code</code>, <code>created_at</code> e <code>updated_at</code>.
get/v1/customers
Query parameters
pageinteger
Page of results to fetch.
per_pageinteger
Number of results to return per page.
querystring
Filtro para busca
sort_by'id' | 'name' | 'status' | 'code' | 'email' | 'registry_code' | 'created_at' | 'updated_at'
Atributo opcional para ordenação
sort_order'asc' | 'desc'
Sentido opcional para ordenação
Response
Consulta realizada com sucesso.