List Customers

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, pagination } = 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']

{
  "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": {
    "per_page": 20,
    "next_cursor": "eyJpZCI6NTB9",
    "prev_cursor": null,
    "has_more_pages": true
  }
}

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, pagination } = 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']

{
  "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": {
    "per_page": 20,
    "next_cursor": "eyJpZCI6NTB9",
    "prev_cursor": null,
    "has_more_pages": true
  }
}

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.

Required scopes: customers.read and customers.pii.read. Granting customers.pii.read alone is enough, as it includes customers.read. A key without them receives a 403 error. See Authentication.

Query Parameters

integer

default:"10"

Number of customers to return per page (1 to 100). A value above 100 returns a 422 validation error.

string

Cursor for pagination. Use the next_cursor from the previous response.

string

Search customers by first name, last name, email or phone number

string

Only return customers created on or after this date (Y-m-d format, e.g., 2025-01-01)

string

Only return customers created on or before this date (Y-m-d format, e.g., 2025-01-31). Must not be earlier than from.

string

Shortcut for a date range, used instead of from and to: today, yesterday, last7days, last30days, thisWeek, lastWeek, thisMonth, lastMonth, thisYear or lastYear

Customers are returned newest first. start_date and end_date are not supported and are silently ignored: use from and to.

Response

array

Array of customer objects

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

string

International formatted phone number (e.g., +1 234 567 890)

object

Country information

Show country object

string

Country name

string

ISO 3166-1 alpha-2 country code

string

ISO 3166-1 alpha-3 country code

string

Country dial code

string

Country currency code

string

Country flag emoji

object

Store information

Show store object

string

Store public ID

string

Store name

string

Store logo URL

string

Store URL

string

ISO 8601 timestamp of when the customer was created

string

ISO 8601 timestamp of when the customer was last updated

object

Cursor pagination metadata

Show pagination object

string | null

Cursor for the next page (null if no more pages)

string | null

Cursor for the previous page (null on the first page)

boolean

Whether there are more pages available

integer

Number of items per page

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, pagination } = 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']

{
  "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": {
    "per_page": 20,
    "next_cursor": "eyJpZCI6NTB9",
    "prev_cursor": null,
    "has_more_pages": true
  }
}

Overview

Store

Products

Checkout

Sales

Customers

Licenses

Discounts

Pulses

Affiliates

Query Parameters

Response

​Query Parameters

​Response

Query Parameters

Response