DesenvolvedoresReferência da APIClientes
Listar clientes
GET
Clientes da loja, do mais recente para o mais antigo, com busca por nome ou e-mail e filtro por status. O documento sai só com os 4 últimos dígitos.
Chave: Só chave secreta (chamada pelo servidor).
Escopo: customers:read.
chaveSecretaheader
AutorizaçãoBearer <chave de API>Chave secreta (sk_…). Use só no servidor; requisições de navegador (com Origin) são recusadas.
limit?integerItens por página (1 a 100).
Intervalo
1 <= value <= 100Padrão
20cursor?stringValor de meta.pagination.nextCursor da página anterior.
Tamanho
length <= 200q?stringBusca por nome ou e-mail.
Tamanho
length <= 100status?stringValue in
"active""blocked"Sucesso.
application/json- response
data*array<>meta*curl -X GET 'https://minepag.com.br/api/v1/customers'{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "email": "string", "name": "string", "phone": "string", "document": { "type": "cpf", "last4": "string" }, "status": "active", "source": "checkout", "marketingConsent": true, "notes": "string", "metrics": { "paidOrdersCount": -9007199254740991, "lifetimeValue": -9007199254740991, "refundedTotal": -9007199254740991, "firstOrderAt": "2019-08-24T14:15:22Z", "lastOrderAt": "2019-08-24T14:15:22Z" }, "createdAt": "2019-08-24T14:15:22Z" } ], "meta": { "requestId": "string", "pagination": { "limit": -9007199254740991, "hasMore": true, "nextCursor": "string" } }}