Membros
  1. Customers
Membros
  • Membros API V2
    • API Keys
      • API info
      • Available scopes
      • Merchant by public key
      • List API keys
      • Create API key
      • Update API key
      • Delete API key
    • Customers
      • List customers
        GET
      • Create customer
        POST
      • Get customer
        GET
      • Update customer
        PUT
    • Plans
      • List plans
      • Create plan
      • Get plan
      • Update plan
      • Delete plan
    • Subscriptions
      • List subscriptions
    • Orders
      • List orders
      • Create order
      • Create PIX order
      • Get order
    • Analytics
      • Analytics placeholder
    • Projects
      • List projects
      • Create project
      • Get project
      • Update project
      • Delete project
      • Update status
      • Project stats
      • Activate project
      • Suspend project
      • Archive project
    • Products
      • List products
      • Create product
      • Get product
      • Update product
      • Delete product
    • Webhooks
      • List webhooks
      • Create webhook
      • Webhook events
      • List logs
      • Get log
      • Get webhook
      • Update webhook
      • Delete webhook
      • Regenerate signing key
      • Send test
      • Logs for webhook
      • Retry webhook
    • Esquemas
      • Pagination
      • BasicMessage
      • PendingFeature
      • ApiInfo
      • Customer
      • CustomerCreateRequest
      • CustomerEnvelope
      • CustomerListResponse
      • Plan
      • PlanRequest
      • PlanEnvelope
      • PlanListResponse
      • OrderCustomer
      • OrderItem
      • Order
      • OrderCreateRequest
      • Product
      • ProductCreateRequest
      • ProductUpdateRequest
      • ProductEnvelope
      • ProductListResponse
      • ProjectStatus
      • ProjectVisibility
      • ProjectType
      • Project
      • ProjectCreateRequest
      • ProjectUpdateRequest
      • ProjectEnvelope
      • ProjectListResponse
      • ProjectStats
      • WebhookEvent
      • Webhook
      • WebhookCreateRequest
      • WebhookUpdateRequest
      • WebhookEventCatalog
      • WebhookLog
      • WebhookListResponse
      • WebhookLogListResponse
      • WebhookLogSlice
      • ScopeCatalog
      • ApiKey
      • ApiKeyCreateRequest
      • ApiKeyUpdateRequest
      • ApiKeyCreateResponse
      • ApiKeyEnvelope
      • ApiKeyListResponse
      • MerchantLookupResponse
  1. Customers

List customers

GET
/v2/customers

Requisição

Authorization
Bearer Token
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
or
Parâmetros de Consulta

Respostas

🟢200OK
application/json
Customers
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v2/customers?page&limit' \
--header 'Authorization: Bearer <token>'
Response Response Example
{
    "error": true,
    "customers": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "type": "individual",
            "name": "string",
            "email": "user@example.com",
            "document": "string",
            "document_type": "cpf",
            "phones": {
                "mobile_phone": {
                    "country_code": "string",
                    "area_code": "string",
                    "number": "string"
                }
            },
            "address": {
                "line_1": "string",
                "line_2": "string",
                "zip_code": "string",
                "city": "string",
                "state": "string",
                "country": "string"
            },
            "metadata": {
                "property1": "string",
                "property2": "string"
            },
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z"
        }
    ],
    "pagination": {
        "totalRecords": 0,
        "totalPages": 0,
        "currentPage": 0,
        "prevPage": 0,
        "nextPage": 0
    }
}
Modificado em 2025-11-15 15:11:05
Página anterior
Delete API key
Próxima página
Create customer
Built with