List Customers
curl --request GET \
--url https://{brand_domain}/api/v1/customers \
--header 'Authorization: Bearer <token>'import requests
url = "https://{brand_domain}/api/v1/customers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{brand_domain}/api/v1/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://{brand_domain}/api/v1/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 => [
"Authorization: Bearer <token>"
],
]);
$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://{brand_domain}/api/v1/customers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{brand_domain}/api/v1/customers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{brand_domain}/api/v1/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"id": 58,
"uuid": "83b9c9d2-b2f4-4df1-bc1e-b810d1c810d1",
"name": "Alice Smith",
"email": "[email protected]",
"phone": "+8801800000000",
"email_masked": "a***[email protected]",
"phone_masked": "+88018******00",
"created_at": "2026-06-23T14:15:45Z"
}
],
"meta": {
"page": 1,
"per_page": 25,
"total": 98
}
}List Customers
Retrieves a paginated list of customer records for the active brand. PII values (name, email, phone) are securely processed. Masked helper fields are provided for general display lists.
GET
/
customers
List Customers
curl --request GET \
--url https://{brand_domain}/api/v1/customers \
--header 'Authorization: Bearer <token>'import requests
url = "https://{brand_domain}/api/v1/customers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{brand_domain}/api/v1/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://{brand_domain}/api/v1/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 => [
"Authorization: Bearer <token>"
],
]);
$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://{brand_domain}/api/v1/customers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{brand_domain}/api/v1/customers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{brand_domain}/api/v1/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"id": 58,
"uuid": "83b9c9d2-b2f4-4df1-bc1e-b810d1c810d1",
"name": "Alice Smith",
"email": "[email protected]",
"phone": "+8801800000000",
"email_masked": "a***[email protected]",
"phone_masked": "+88018******00",
"created_at": "2026-06-23T14:15:45Z"
}
],
"meta": {
"page": 1,
"per_page": 25,
"total": 98
}
}Authorizations
Provide the Bearer API Key generated for your brand.
Query Parameters
Page number to retrieve.
Required range:
x >= 1Records per page.
Required range:
1 <= x <= 100Last modified on July 12, 2026
Related topics
OwnPay API Overview - REST API for Multi-Brand PaymentsFeatures and CapabilitiesLaravel SDK - Fluent Payment Integration for PHP AppsMerchant API Reference - Payments, Refunds, and WebhooksCustomers - Profiles, Transaction History, and MethodsWas this page helpful?
⌘I