Xpend | API Documentation
  1. Clientes
Xpend | API Documentation
  • Admin
    • Aprovar empresa
      POST
    • Listar empresas
      GET
    • Listar solicitações empresas
      GET
    • Receitas
      GET
    • Listar todos os pagamentos
      GET
    • Listar total de transações
      GET
    • Listar dados de faturamento
      GET
    • Aprovar saque
      POST
    • Listar todas solicitações de saques
      GET
    • Dashboard
      GET
    • Reprovar saque
      POST
    • Listar configurações de saques
      GET
    • Listar configurações de saque por ID
      GET
    • Atualizar configuração de saque por ID
      PUT
    • Listar taxas
      GET
    • Listar taxa por ID
      GET
    • Listar todas as transações
      GET
    • Listar administradores 🚧
      GET
    • Listar configurações
      GET
    • Listar configurações por ID
      GET
    • Atualizar configurações
      PUT
  • Default
    • Criar uma taxa
      POST
    • Atualizar uma taxa
      PUT
    • Criar saque 🚧
      POST
    • Listar todos saques
      GET
    • Obter saque por ID
      GET
    • Listar taxas
      GET
    • Listar todas as transações
      GET
    • Obter transações por ID
      GET
  • Autenticação
    • Registro de usuário
    • Login
    • Refresh token
  • Dashboard
    • Resumo
  • Empresas
    • Criar empresa
    • Atualizar empresa
    • Excluir empresa
    • Enviar documentos
    • Atualizar documentos
    • Listar empresas
  • Integrações
    • Login API
    • Obter credenciais
    • Atualizar credenciais
  • Links de Pagamento
    • Criar link de pagamento
    • Listar links de pagamento
    • Obter link de pagamento pelo hash
    • Excluir link de pagamento
  • Pagamentos
    • Criar novo pagamento
    • Listar pagamentos
    • Listar pagamento por ID
  • Usuários
    • Criar usuário
    • Listar usuário por ID
    • Atualizar usuário
    • Excluir usuário
    • Atualizar senha
  • Saldo
    • Obter saldo
  • Clientes
    • Criar novo cliente vendedor
      POST
    • Listar clientes vendedores
      GET
    • Obter um cliente vendedor por ID
      GET
    • Atualizar cliente vendedor
      PATCH
  • Webhooks
    • Criar webhook
    • Listar webhooks
    • Excluir webhook
  • Status
    • Eventos de saque (exemplos)
    • Status
  • Schemas
    • Admin__api_v1_admin_enterprises_By_id__POST__Response_200
    • Admin__api_v1_admin_enterprises_By_id__POST__Response_400
    • Admin__api_v1_admin_enterprises__GET__Response_200
    • Admin__api_v1_admin_enterprises__GET__Response_401
    • Admin__api_v1_admin_enterprises_request__GET__Response_200
    • Admin__api_v1_admin_enterprises_revenue__GET__Response_200
    • Admin__api_v1_admin_payments__GET__Response_200
    • Admin__api_v1_admin_payments_total_transactions__GET__Response_200
    • Admin__api_v1_admin_payments_billing__GET__Response_200
    • Admin__api_v1_admin_withdrawals_request__GET__Response_200
    • Admin__api_v1_admin_withdrawals_dashboard__GET__Response_200
    • Admin__api_v1_admin_withdrawal_configs_By_sellerId__GET__Response_200
    • Admin__api_v1_admin_withdrawal_configs_By_sellerId__PUT__Request
    • Default__api_v1_fees__POST__Request
    • Default__api_v1_fees__POST__Response_201
    • Admin__api_v1_admin_fees__GET__Response_200
    • Default__api_v1_fees_By_id__PUT__Response_200
    • Admin__api_v1_admin_members__GET__Response_200
    • Admin__api_v1_admin_reserve_configs__GET__Response_200
    • Admin__api_v1_admin_reserve_configs_By_sellerId__GET__Response_200
    • Admin__api_v1_admin_reserve_configs_By_sellerId__PUT__Request
    • Autenticacao__api_v1_auth_register__POST__Request
    • Autenticacao__api_v1_auth_register__POST__Response_201
    • Autenticacao__api_v1_auth_register__POST__Response_400
    • Autenticacao__api_v1_auth_login__POST__Request
    • Autenticacao__api_v1_auth_login__POST__Response_200
    • Autenticacao__api_v1_auth_refresh__POST__Request
    • Autenticacao__api_v1_auth_refresh__POST__Response_200
    • Dashboard__api_v1_dashboard_overview__GET__Response_200
    • Empresas__api_v1_enterprises__POST__Request
    • Empresas__api_v1_enterprises__POST__Response_201
    • Empresas__api_v1_enterprises__PATCH__Response_200
    • Empresas__api_v1_enterprises__DELETE__Response_204
    • Empresas__api_v1_enterprises_By_id__POST__Request
    • Empresas__api_v1_enterprises_By_id__POST__Response_400
    • Empresas__api_v1_enterprises_By_id_documents_By_type__PATCH__Request
    • Empresas__api_v1_enterprises_By_id_documents_By_type__PATCH__Response_200
    • Integracoes__api_v1_api_auth_login__POST__Request
    • Integracoes__api_v1_api_auth_login__POST__Response_200
    • Integracoes__api_v1_integrations_credentials__GET__Response_201
    • Links_de_Pagamento__api_v1_payment_links__POST__Request
    • Links_de_Pagamento__api_v1_payment_links__POST__Response_201
    • Links_de_Pagamento__api_v1_payment_links__GET__Response_200
    • Pagamentos__api_v1_payments__POST__Request
    • Pagamentos__api_v1_payments__POST__Response_200
    • Pagamentos__api_v1_payments_By_id__GET__Response_200
    • Default__api_v1_withdrawals__POST__Request
    • Default__api_v1_withdrawals__POST__Response_201
    • Default__api_v1_withdrawals__GET__Response_200
    • Usuarios__api_v1_users__POST__Request
    • Usuarios__api_v1_users_By_id__GET__Response_200
    • Usuarios__api_v1_users_By_id__PATCH__Request
    • Usuarios__api_v1_users_By_id_password__PATCH__Request
    • Saldo__api_v1_seller_balances_me__GET__Response_200
    • Clientes__api_v1_customers__POST__Request
    • Clientes__api_v1_customers__POST__Response_201
    • Clientes__api_v1_customers__GET__Response_200
    • Webhooks__api_v1_seller_webhooks__POST__Request
    • Webhooks__api_v1_seller_webhooks__POST__Response_201
    • Status__Root__GET__Response_200
    • Status__api_v1_status__GET__Response_200
    • Error_Unauthorized
    • Error_Standard
  1. Clientes

Listar clientes vendedores

GET
/api/v1/customers
Endpoint para listar todos clientes vendedores.

💾 Estrutura de Dados#

Headers#

Authorization: Bearer <JWT_TOKEN>

Body (JSON)#

Não aplicável

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Query Params

Responses

🟢200
application/json
Body

🟠401
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://xpend-backend.onrender.com/api/v1/customers?page=1&perPage=10' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Success
{
    "data": [
        {
            "id": "caea9d4a-9047-433d-a2f8-877b29b5e8c8",
            "sellerId": "e9832f40-2680-4753-9f61-a8b0323c12bf",
            "name": "John Doe",
            "email": "johndoe.seller@domain.com",
            "phone": null,
            "documentType": "CPF",
            "documentNumber": "23259190058",
            "createdAt": "2025-11-13T14:50:57.810Z",
            "updatedAt": "2025-11-13T14:50:57.810Z"
        }
    ],
    "totalRecords": 1,
    "totalPages": 1,
    "perPage": 50,
    "currentPage": 1
}
Modified at 2025-12-27 01:31:55
Previous
Criar novo cliente vendedor
Next
Obter um cliente vendedor por ID
Built with