List Customers

cURL

curl --request GET \
  --url https://sandbox.zapyd.com/cms/api/v1/customer/list \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-SIGNATURE: <api-key>' \
  --header 'X-TIMESTAMP: <api-key>'

import requests

url = "https://sandbox.zapyd.com/cms/api/v1/customer/list"

headers = {
    "X-API-KEY": "<api-key>",
    "X-TIMESTAMP": "<api-key>",
    "X-SIGNATURE": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'X-API-KEY': '<api-key>',
    'X-TIMESTAMP': '<api-key>',
    'X-SIGNATURE': '<api-key>'
  }
};

fetch('https://sandbox.zapyd.com/cms/api/v1/customer/list', 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://sandbox.zapyd.com/cms/api/v1/customer/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>",
    "X-SIGNATURE: <api-key>",
    "X-TIMESTAMP: <api-key>"
  ],
]);

$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://sandbox.zapyd.com/cms/api/v1/customer/list"

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

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("X-TIMESTAMP", "<api-key>")
	req.Header.Add("X-SIGNATURE", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://sandbox.zapyd.com/cms/api/v1/customer/list")
  .header("X-API-KEY", "<api-key>")
  .header("X-TIMESTAMP", "<api-key>")
  .header("X-SIGNATURE", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.zapyd.com/cms/api/v1/customer/list")

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

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
request["X-TIMESTAMP"] = '<api-key>'
request["X-SIGNATURE"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "status": true,
  "message": "Success",
  "data": {
    "count": 1,
    "next": null,
    "previous": "<url>",
    "results": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "status": "VERIFIED",
        "full_name": "John Doe",
        "email": "john.doe@example.com",
        "phone": "+1234567890",
        "country": "USA",
        "client_reference_id": "cust_12345",
        "type": "INDIVIDUAL",
        "failure_reason": null
      }
    ]
  }
}

{
  "status": false,
  "message": "Internal Server Error",
  "data": null,
  "err_code": "SYS_INTERNAL_ERROR",
  "errors": "Unexpected error occurred. Please try again later."
}

GET

customer

list

cURL

curl --request GET \
  --url https://sandbox.zapyd.com/cms/api/v1/customer/list \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-SIGNATURE: <api-key>' \
  --header 'X-TIMESTAMP: <api-key>'

import requests

url = "https://sandbox.zapyd.com/cms/api/v1/customer/list"

headers = {
    "X-API-KEY": "<api-key>",
    "X-TIMESTAMP": "<api-key>",
    "X-SIGNATURE": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'X-API-KEY': '<api-key>',
    'X-TIMESTAMP': '<api-key>',
    'X-SIGNATURE': '<api-key>'
  }
};

fetch('https://sandbox.zapyd.com/cms/api/v1/customer/list', 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://sandbox.zapyd.com/cms/api/v1/customer/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>",
    "X-SIGNATURE: <api-key>",
    "X-TIMESTAMP: <api-key>"
  ],
]);

$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://sandbox.zapyd.com/cms/api/v1/customer/list"

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

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("X-TIMESTAMP", "<api-key>")
	req.Header.Add("X-SIGNATURE", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://sandbox.zapyd.com/cms/api/v1/customer/list")
  .header("X-API-KEY", "<api-key>")
  .header("X-TIMESTAMP", "<api-key>")
  .header("X-SIGNATURE", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.zapyd.com/cms/api/v1/customer/list")

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

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
request["X-TIMESTAMP"] = '<api-key>'
request["X-SIGNATURE"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "status": true,
  "message": "Success",
  "data": {
    "count": 1,
    "next": null,
    "previous": "<url>",
    "results": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "status": "VERIFIED",
        "full_name": "John Doe",
        "email": "john.doe@example.com",
        "phone": "+1234567890",
        "country": "USA",
        "client_reference_id": "cust_12345",
        "type": "INDIVIDUAL",
        "failure_reason": null
      }
    ]
  }
}

{
  "status": false,
  "message": "Internal Server Error",
  "data": null,
  "err_code": "SYS_INTERNAL_ERROR",
  "errors": "Unexpected error occurred. Please try again later."
}

List Customers

Open in Cursor

API Status Code	Response	Reason
500	Internal Server Error.	Internal Server Error

Authorizations

X-API-KEY

string

header

required

API Key for authentication

X-TIMESTAMP

string

header

required

Current timestamp in seconds since epoch

X-SIGNATURE

string

header

required

HMAC SHA256 signature of the request encoded in Base64

Query Parameters

string

Search by name, email, phone, client_reference_id or customer id (min 3 characters)

country

string

Filter by ISO alpha-3 country code

customer_status

string

Filter by customer status

customer_type

enum<string>

Filter by customer type

Available options:

INDIVIDUAL,

BUSINESS,

UBO

start_date

string<date>

Created on or after (YYYY-MM-DD). Applied only together with end_date.

end_date

string<date>

Created on or before (YYYY-MM-DD). Applied only together with start_date.

order_by

string

default:-created_at

Sort field; prefix with - for descending

page

integer

default:1

Page number

Required range: x >= 1

per_page

integer

default:20

Results per page (10–100)

Required range: 10 <= x <= 100

Response

List of customers fetched successfully

status

boolean

Example:

true

message

string

Example:

"Success"

data

object

Hide child attributes

data.count

integer

Example:

1

data.next

string | null

Example:

null

data.previous

string | null

Example:

"<url>"

data.results

object[]

Hide child attributes

data.results.id

string<uuid>

Example:

"550e8400-e29b-41d4-a716-446655440000"

data.results.status

string

Example:

"VERIFIED"

data.results.full_name

string

Example:

"John Doe"

data.results.email

string

Example:

"john.doe@example.com"

data.results.phone

string

Example:

"+1234567890"

data.results.country

string

Example:

"USA"

data.results.client_reference_id

string

Example:

"cust_12345"

data.results.type

string

Example:

"INDIVIDUAL"

data.results.failure_reason

null

Example:

null

Using the API

Onboarding

Money movement

Platform

Sandbox

List Customers

Authorizations

Query Parameters

Response