curl --request GET \
--url https://api.zupy.com/api/v2/customers/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.zupy.com/api/v2/customers/"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.zupy.com/api/v2/customers/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zupy.com/api/v2/customers/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.zupy.com/api/v2/customers/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zupy.com/api/v2/customers/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zupy.com/api/v2/customers/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"full_name": "<string>",
"avatar_url": "<string>",
"email": "<string>",
"phone": "<string>",
"cpf": "<string>",
"birth_date": "<string>",
"points_balance": 123,
"points_earned": 123,
"points_spent": 123,
"tier": "default",
"card_number": "<string>",
"join_date": "2023-11-07T05:31:56Z",
"last_activity_date": "2023-11-07T05:31:56Z",
"is_active": true,
"zupy_balance": "<string>",
"program_id": "<string>",
"program_name": "<string>",
"rfm_segment": "<string>",
"company_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_email_verified": true,
"is_phone_verified": true
}
],
"meta": {
"cursor": "<string>",
"has_next": true,
"count": 123
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Search and list customers
Paginated customer list with filters for name, email, phone, card code, tier, and RFM segment.
curl --request GET \
--url https://api.zupy.com/api/v2/customers/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.zupy.com/api/v2/customers/"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.zupy.com/api/v2/customers/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zupy.com/api/v2/customers/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.zupy.com/api/v2/customers/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zupy.com/api/v2/customers/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zupy.com/api/v2/customers/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"full_name": "<string>",
"avatar_url": "<string>",
"email": "<string>",
"phone": "<string>",
"cpf": "<string>",
"birth_date": "<string>",
"points_balance": 123,
"points_earned": 123,
"points_spent": 123,
"tier": "default",
"card_number": "<string>",
"join_date": "2023-11-07T05:31:56Z",
"last_activity_date": "2023-11-07T05:31:56Z",
"is_active": true,
"zupy_balance": "<string>",
"program_id": "<string>",
"program_name": "<string>",
"rfm_segment": "<string>",
"company_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_email_verified": true,
"is_phone_verified": true
}
],
"meta": {
"cursor": "<string>",
"has_next": true,
"count": 123
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Authorizations
Per-company partner API key (zupy_pk_…). Validated by Zupy against the company integration key hash (Story 14.x); send it on every request as the X-API-Key header. Scoped read-write to the owning company's data.
Query Parameters
Filter by card number/code (case-insensitive contains)
Pagination cursor value from previous response.
Filter by email address (case-insensitive contains)
Filter by customer name (case-insensitive contains)
Number of results to return per page.
Filter by phone number (digits only, case-insensitive contains)
General text search across name, email, phone, and card code
Filter by RFM segment (champions, loyal, promising, at_risk, new)
Filter by loyalty tier (exact match: default, bronze, silver, gold, platinum, vip)