curl -X GET "https://api.chariow.com/v1/customers?per_page=20&search=john" \
-H "Authorization: Bearer sk_live_your_api_key"
const response = await fetch('https://api.chariow.com/v1/customers?per_page=20&search=john', {
headers: {
'Authorization': 'Bearer sk_live_your_api_key'
}
});
const { data } = await response.json();
$ch = curl_init('https://api.chariow.com/v1/customers?per_page=20&search=john');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer sk_live_your_api_key'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$data = json_decode($response, true);
import requests
response = requests.get(
'https://api.chariow.com/v1/customers',
params={'per_page': 20, 'search': 'john'},
headers={'Authorization': 'Bearer sk_live_your_api_key'}
)
data = response.json()['data']
{
"message": "success",
"data": {
"data": [
{
"id": "cus_abc123xyz",
"name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"email": "john@example.com",
"avatar_url": "https://cdn.chariow.com/avatars/abc123.jpg",
"phone": {
"number": "+1 234 567 890",
"country": {
"name": "United States",
"code": "US",
"alpha_3_code": "USA",
"dial_code": "+1",
"currency": "USD",
"flag": "🇺🇸"
}
},
"store": {
"id": "str_xyz789",
"name": "My Digital Store",
"logo_url": "https://cdn.chariow.com/stores/xyz789/logo.png",
"url": "https://mystore.chariow.link"
},
"created_at": "2025-01-15T10:30:00+00:00",
"updated_at": "2025-01-20T14:45:00+00:00"
}
],
"pagination": {
"next_cursor": "eyJpZCI6NTB9",
"prev_cursor": null,
"has_more": true
}
},
"errors": []
}
Customers
List Customers
Retrieve all customers from your store
curl -X GET "https://api.chariow.com/v1/customers?per_page=20&search=john" \
-H "Authorization: Bearer sk_live_your_api_key"
const response = await fetch('https://api.chariow.com/v1/customers?per_page=20&search=john', {
headers: {
'Authorization': 'Bearer sk_live_your_api_key'
}
});
const { data } = await response.json();
$ch = curl_init('https://api.chariow.com/v1/customers?per_page=20&search=john');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer sk_live_your_api_key'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$data = json_decode($response, true);
import requests
response = requests.get(
'https://api.chariow.com/v1/customers',
params={'per_page': 20, 'search': 'john'},
headers={'Authorization': 'Bearer sk_live_your_api_key'}
)
data = response.json()['data']
{
"message": "success",
"data": {
"data": [
{
"id": "cus_abc123xyz",
"name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"email": "john@example.com",
"avatar_url": "https://cdn.chariow.com/avatars/abc123.jpg",
"phone": {
"number": "+1 234 567 890",
"country": {
"name": "United States",
"code": "US",
"alpha_3_code": "USA",
"dial_code": "+1",
"currency": "USD",
"flag": "🇺🇸"
}
},
"store": {
"id": "str_xyz789",
"name": "My Digital Store",
"logo_url": "https://cdn.chariow.com/stores/xyz789/logo.png",
"url": "https://mystore.chariow.link"
},
"created_at": "2025-01-15T10:30:00+00:00",
"updated_at": "2025-01-20T14:45:00+00:00"
}
],
"pagination": {
"next_cursor": "eyJpZCI6NTB9",
"prev_cursor": null,
"has_more": true
}
},
"errors": []
}
Retrieves a cursor-paginated list of all customers in your store. Customers are created automatically when they make a purchase. This endpoint supports search filtering and date range filtering.
Query Parameters
integer
default:"15"
Number of customers to return per page (max 100)
string
Cursor for pagination. Use the
next_cursor from the previous response.string
Search customers by name, email, or phone number
string
Filter customers created from this date (Y-m-d format, e.g.,
2025-01-01)string
Filter customers created until this date (Y-m-d format, e.g.,
2025-01-31)Response
object
Show properties
Show properties
array
Array of customer objects
Show customer object
Show customer object
string
Unique customer identifier (e.g.,
cus_abc123xyz)string
Customer full name (combination of first and last name)
string
Customer first name
string
Customer last name
string
Customer email address
string
URL to the customer’s avatar image
object
Customer phone number
Show phone object
Show phone object
object
string
ISO 8601 timestamp of when the customer was created
string
ISO 8601 timestamp of when the customer was last updated
curl -X GET "https://api.chariow.com/v1/customers?per_page=20&search=john" \
-H "Authorization: Bearer sk_live_your_api_key"
const response = await fetch('https://api.chariow.com/v1/customers?per_page=20&search=john', {
headers: {
'Authorization': 'Bearer sk_live_your_api_key'
}
});
const { data } = await response.json();
$ch = curl_init('https://api.chariow.com/v1/customers?per_page=20&search=john');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer sk_live_your_api_key'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$data = json_decode($response, true);
import requests
response = requests.get(
'https://api.chariow.com/v1/customers',
params={'per_page': 20, 'search': 'john'},
headers={'Authorization': 'Bearer sk_live_your_api_key'}
)
data = response.json()['data']
{
"message": "success",
"data": {
"data": [
{
"id": "cus_abc123xyz",
"name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"email": "john@example.com",
"avatar_url": "https://cdn.chariow.com/avatars/abc123.jpg",
"phone": {
"number": "+1 234 567 890",
"country": {
"name": "United States",
"code": "US",
"alpha_3_code": "USA",
"dial_code": "+1",
"currency": "USD",
"flag": "🇺🇸"
}
},
"store": {
"id": "str_xyz789",
"name": "My Digital Store",
"logo_url": "https://cdn.chariow.com/stores/xyz789/logo.png",
"url": "https://mystore.chariow.link"
},
"created_at": "2025-01-15T10:30:00+00:00",
"updated_at": "2025-01-20T14:45:00+00:00"
}
],
"pagination": {
"next_cursor": "eyJpZCI6NTB9",
"prev_cursor": null,
"has_more": true
}
},
"errors": []
}
Was this page helpful?
⌘I