VIvindi
customers

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

Request

  • Base URL
    //app.vindi.com.br/api (relative, and the document’s source URL is not known)
  • URL
    //app.vindi.com.br/api/v1/customers
  • Auth
    HTTP basic

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.

idinteger required

ID do cliente

namestring required

Nome do cliente

emailstring

E-mail do cliente

registry_codestring

CPF ou CNPJ do cliente

codestring

Código opcional para referência via API

notesstring

Observações adicionais internas sobre o cliente

status'active' | 'inactive' | 'archived' required

Status do cliente

created_atstring required

Data e hora do cadastro do cliente

updated_atstring required

Data e hora da última atualização do cliente

metadataobject

Metadados do cliente

Changes

No recorded changes to this operation across all 1 revision of this API.