Skip to main content
GET
/
v1
/
customers
List customers with analytics
curl --request GET \
  --url http://localhost:3000/v1/customers
import requests

url = "http://localhost:3000/v1/customers"

response = requests.get(url)

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

fetch('http://localhost:3000/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_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v1/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 := "http://localhost:3000/v1/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("http://localhost:3000/v1/customers")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3000/v1/customers")

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

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

response = http.request(request)
puts response.read_body
{
  "customers": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "full_name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "created_at": "<string>",
      "analytics": {
        "total_orders": 123,
        "total_spend": 123,
        "average_order_value": 123,
        "orders_pending": 123,
        "orders_completed": 123,
        "orders_cancelled": 123,
        "first_order_at": "<string>",
        "last_order_at": "<string>",
        "price_sensitivity_score": 123
      }
    }
  ],
  "total": 123
}
{
"error": "<string>"
}

Query Parameters

limit
integer
default:20

Max items to return

Required range: 1 <= x <= 100
Example:

20

offset
integer | null
default:0

Items to skip

Required range: x >= 0
Example:

0

Search query

Maximum string length: 200
Example:

"john"

sortBy
enum<string>
default:created_at

Sort field

Available options:
total_spend,
total_orders,
last_order,
created_at
sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc

Response

List of customers

List customers response

customers
object[]
required
total
number
required