Listar clientes

Para listar todas os clientes de uma conta, é necessário ter um token válido e utilizar o endpoint Listar clientes.

Modelo de Requisição:

Request


curl --location 'https://sandbox.openfinance.celcoin.dev//baas/v1/payment-links/customers' \
--header 'Authorization: Bearer *****’

Query Params

Objeto	Campo	Descrição	Tipo	Obrigatório
–	account	Número da conta no BaaS.	string	Sim
-	search	nome, documento, e-mail	string	Não

Response

{
    "version": "1.0.0",
    "body": [
        {
            "id": "6a0e26073b3deb1e41926265",
            "name": "João",
            "surname": "Silva",
            "document": "15663289003",
            "documentType": "CPF",
            "emails": [
                "[email protected]"
            ],
            "phones": [
                "11999999999"
            ],
            "address": {
                "cep": "01310100",
                "street": "Avenida Paulista",
                "number": "1000",
                "state": "SP",
                "city": "São Paulo",
                "neighborhood": "Bela Vista"
            },
            "externalCustomerId": "ext-customer-4975801-002",
            "createdAt": "2026-05-20T21:22:15.173Z",
            "updatedAt": "2026-05-20T21:22:15.173Z"
        },
        {
            "id": "6a1734548a806146a4e79d08",
            "name": "João Silva",
            "surname": "Silva2",
            "document": "15663289003",
            "documentType": "CPF",
            "emails": [
                "[email protected]"
            ],
            "phones": [
                "11999999999"
            ],
            "address": {
                "cep": "01310100",
                "street": "Avenida Paulista",
                "number": "1000",
                "state": "SP",
                "city": "São Paulo",
                "neighborhood": "Bela Vista"
            },
            "externalCustomerId": "ext-customer-4975801-003”,
            "createdAt": "2026-05-27T18:13:40.507Z",
            "updatedAt": "2026-05-27T18:13:40.507Z"
        }
    ],
    "status": 200,
    "page": 1,
    "limit": 20,
    "total": 2,
    "count": 2,
    "hasMore": false
}

Campos da resposta:

Campo	Descrição	tipo
name	Nome completo do cliente.	string
surname	Apelido do cliente, deve ser único no sistema. Ex.: 'joao.silva'. Não é permitido usar o mesmo apelido para outro cliente.	string
document	Número do documento (CPF ou CNPJ). Somente número.	string
documentType	Tipo do documento: "CPF" ou "CNPJ".	array
emails	Lista de e-mails do cliente.	array
phones	Lista de telefones do cliente.	string
address	Endereço do cliente (veja campos abaixo).	string
address.cep	CEP (apenas números)	string
address.street	Nome da rua/avenida	number
address.number	Número do endereço	string
address.state	UF (ex: "SP").	string
address.city	Nome da cidade	string
address.neighborhood	Nome do bairro	string
externalCustomerId	Identificador de controle do cliente no seu sistema.	string