List Customers

List Customers with pagination

GET /v1/customers

List Customers

cURL

curl --request GET \
  --url https://api.wizcommerce.com/v1/customers \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.wizcommerce.com/v1/customers"

headers = {"X-API-Key": "<api-key>"}

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

print(response.text)

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

fetch('https://api.wizcommerce.com/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_URL => "https://api.wizcommerce.com/v1/customers",
  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>"
  ],
]);

$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.wizcommerce.com/v1/customers"

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

	req.Header.Add("X-API-Key", "<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://api.wizcommerce.com/v1/customers")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

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

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

200

{
  "data": [
    {
      "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
      "reference_id": "1234567890",
      "display_id": "WC_1234567890",
      "name": "Customer Name",
      "display_name": "Customer Display Name",
      "first_name": "John",
      "last_name": "Doe",
      "phone": "[phone]",
      "email": "[e-mail]",
      "status": "active",
      "freight_term": "Cust. Pickup",
      "shipping_method": "DHL",
      "payment_mode": "AMEX",
      "payment_term": "NET30",
      "created_at": "2025-01-01T15:04:05Z",
      "updated_at": "2025-01-01T15:04:05Z"
    }
  ],
  "pagination": {
    "total_records": 100,
    "total_pages": 10,
    "current_page": 1,
    "next_page": 2,
    "prev_page": 0,
    "page_size": 10
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "details": [
    {
      "field": "<string>",
      "reason": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "details": [
    {
      "field": "<string>",
      "reason": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "details": [
    {
      "field": "<string>",
      "reason": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "details": [
    {
      "field": "<string>",
      "reason": "<string>"
    }
  ]
}

Authorizations

X-API-Key · string · header · required

API Key for authentication

Query Parameters

page · integer

Required range: x >= 1

page_size · integer

Required range: 1 <= x <= 100

created_after · string

format: 2006-01-02T15:04:05Z (ISO 8601) UTC

created_before · string

format: 2006-01-02T15:04:05Z (ISO 8601) UTC

updated_after · string

format: 2006-01-02T15:04:05Z (ISO 8601) UTC

updated_before · string

format: 2006-01-02T15:04:05Z (ISO 8601) UTC

sort_by · enum<string> · default: updated_at

Available options: created_at, updated_at, company_name, display_name

sort · enum<string> · default: desc

Available options: asc, desc

reference_ids · string[]

List of customer reference ids separated by comma

Response

200

application/json

OK

data · object[]

Show child attributes

pagination · object

Show child attributes