API
Status PageSuporte

Listar Clientes

get
https://sandbox.openfinance.celcoin.dev/baas/v1/cash/customers

Listar os clientes cadastrados para uma conta.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Número da conta no BaaS.

documents
array of strings

CPF ou CNPJ do cliente. Informe apenas números e separe cada um por vírgula.

documents
emails
array of strings

Emails do cliente. Separe cada email por vírgula.

emails
date

Data de criação inicial

date

Data de criação final.

string

Data de criação/atualização inicial.

string

Data de criação/atualização final.

string

Ids do cliente no seu sistema. Separe cada id por vírgula.

string

Ids do cliente na Celcoin. Separe cada id por vírgula.

integer
required

Ponteiro inicial para trazer os registros.

string
enum

Status atual do cliente.

activ = Clientes que possuem assinaturas/cobranças avulsas ativos. delayed = Clientes que têm pelo menos 1 transação vencida com status de negada,em aberto ou decurso de prazo. inactive = Clientes que não possuem assinaturas/cobranças avulsas ativos. withoutSubscriptionOrCharge = Clientes que não têm assinaturas/cobranças avulsas.

Allowed:
integer
required

Qtd máxima de registros para trazer.

string
enum

Ordenação do resultado. String que deverá ser montada da seguinte maneira: campoDaEntidade.tipoDeOrdem

Caso queira passar mais de uma ordenação, separar por vírgula: campoDaEntidade.tipoDeOrdem, campoDaEntidade2.tipoDeOrdem

createdAt.asc = Cliente criado em - Ordem crescente createdAt.desc = Cliente criado em - Ordem decrescente updatedAt.asc = Cliente alterado em - Ordem crescente updatedAt.desc = Cliente alterado em - Ordem decrescente

Allowed:
Responses

Updated 27 days ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 27 days ago