Listar Clientes

Uma vez que os clientes tenham sido criados, é possível fazer a listagem de todos os clientes pertencentes a uma conta.

Para realizar a listagem, é necessário ter um token válido.


Listando clientes

Para realizar a listagem de clientes, utilize o endpoint Listar Clientes.

Importante: caso você tenha utilizado identificadores externos, denominados myId na requisição, os mesmos serão exibidos também na listagem de clientes.

Exemplo de Request

curl --request GET \
     --url 'https://sandbox.openfinance.celcoin.dev/baas/v1/cash/customers?account=1&documents=96139639956%2C84958444351&emails=teste5140email210%40galaxpay.com.br%2Cteste5171email5108%40galaxpay.com.br&createdAtFrom=2026-01-01&createdAtTo=2026-01-01&createdOrUpdatedAtFrom=2026-01-01&createdOrUpdatedAtTo=2026-01-01&myIds=1%2C2%2C3&galaxPayIds=4%2C5%2C6&startAt=0&status=active&limit=10&order=createdAt.asc' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer {TOKEN}'

👍

Sucesso 200

Exemplo de Response


{
    "totalQtdFoundInPage": 1,
    "Customers": [
        {
            "galaxPayId": 1,
            "myId": "pay-69989591c72018.92270541",
            "name": "Lorem ipsum dolor sit amet.",
            "document": "10195953703",
            "emails": [
                "[email protected]",
                "[email protected]"
            ],
            "phones": [
                3140201512,
                31983890110
            ],
            "status": "active",
            "createdAt": "2020-06-02 10:10:00",
            "updatedAt": "2020-06-02 10:10:00",
            "Address": {
                "zipCode": "30411330",
                "street": "Rua platina",
                "number": "1330",
                "complement": "2º andar",
                "neighborhood": "Prado",
                "city": "Belo Horizonte",
                "state": "MG"
            }
        }
    ]
}