Listar meus clientes

GET

/api/customers

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Consulta

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://sandbox.enterpay.com.br/api/customers?name=Empresa A' \
--header 'Authorization: Bearer <token>'

Respostas

🟢200Success

application/json

Body

Exemplo

{
    "success": true,
    "message": "Operação realizada com sucesso.",
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": 1,
                "name": "Igor",
                "document_type": "cpf",
                "document_number": "738.291.460-78",
                "birthdate": "1990-01-01",
                "phone": "+5511999900123",
                "email": "igor@example.com",
                "document_file": null,
                "social_contract_file": null,
                "proof_residence_file": null,
                "customer_business_id": 1,
                "customer_payer_id": 1,
                "created_at": "2024-10-03T20:44:16.000000Z",
                "updated_at": "2024-10-03T20:44:16.000000Z",
                "deleted_at": null
            }
        ],
        "first_page_url": "http://localhost:8088/api/customers?name=Igor&page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "http://localhost:8088/api/customers?name=Igor&page=1",
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "http://localhost:8088/api/customers?name=Igor&page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "next_page_url": null,
        "path": "http://localhost:8088/api/customers",
        "per_page": 15,
        "prev_page_url": null,
        "to": 1,
        "total": 1
    }
}

Modificado em 2024-10-03 20:58:50

Página anterior

Buscar um cliente

Próxima página

Cadastrar novo cliente