List customers (offset pagination, filters)

GET

/admin/v1/customers

const url = 'https://your-store.example.com/admin/v1/customers?page=1&pageSize=20';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://your-store.example.com/admin/v1/customers?page=1&pageSize=20'

Parameters

Query Parameters

page

integer

default: 1 >= 1 <= 9007199254740991

pageSize

integer

default: 20 >= 1 <= 200

email

string

>= 1 characters <= 320 characters

isB2b

string

List customers (offset pagination, filters)

Parameters

Query Parameters

Responses

200