Skip to main content
GET
/
api
/
v1
/
developer
/
customers
List customers
curl --request GET \
  --url https://api.example.com/api/v1/developer/customers
import requests

url = "https://api.example.com/api/v1/developer/customers"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/api/v1/developer/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.example.com/api/v1/developer/customers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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.example.com/api/v1/developer/customers"

	req, _ := http.NewRequest("GET", url, nil)

	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.example.com/api/v1/developer/customers")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/developer/customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
Required scope: customers:read Rate limit: 300 requests/minute

​
Pagination

Supports both cursor pagination (recommended) and page pagination (deprecated). The cursor shape wins if both are supplied. Both shapes apply the same in-process name match (capped at 1,000 candidate rows) and return identical row sets for the same search term.

​
Query parameters

ParameterTypeDefaultNotes
cursorstring–Opaque cursor from a previous response’s next_cursor
limitinteger501–100

​
Page shape (deprecated)

Use cursor pagination for new integrations – see Pagination.
ParameterTypeDefaultNotes
pageinteger11-indexed
per_pageinteger501–100

​
Filters (both shapes)

ParameterTypeDefaultNotes
searchstring–Matches an email exactly (when shaped like an email) or matches the customer’s name (case-insensitive). The name fallback applies in both shapes.
Email and name fields are stored encrypted and matched via deterministic lookup hashes; substring matching on names happens in-process across at most 1,000 candidate rows. The same cap applies to cursor and page walks.

​
Response

Cursor shape: 
{
  "customers": [
    {
      "id": "c0ffee00-0000-4000-8000-000000000001",
      "email": "buyer@example.com",
      "first_name": "Alex",
      "last_name": "Buyer",
      "total_ltv": "175.00",
      "created_at": "2026-04-26T01:23:45Z",
      "location_id": null
    }
  ],
  "next_cursor": "cur_v1_eyJ2IjoxLCJ0Ijoi…uH8.QwR2…"
}
Page shape (deprecated): 
{
  "customers": [/* …items… */],
  "total": 102,
  "page": 1,
  "per_page": 50
}
total_ltv is the sum of all voucher purchases attributed to this customer.

​
Examples

curl \
  -H "X-API-Key: vg_live_EXAMPLEdoNotUseThis123456" \
  "https://api.vouchergrid.com/api/v1/developer/customers?search=buyer@example.com"

const params = new URLSearchParams({ search: "buyer@example.com" });
const res = await fetch(
  `https://api.vouchergrid.com/api/v1/developer/customers?${params}`,
  { headers: { "X-API-Key": process.env.VOUCHERGRID_API_KEY! } },
);
const data = await res.json();