List customers

GET
/admin/customers

Authorization

headerx-api-key<token>

Organization-scoped API key with scope metadata.

Query Parameters

page?integer
Range0 < value <= 9007199254740991
perPage?integer
Range0 < value <= 200
search?string
sortField?string

createdAt: when the customer was added. spent: what they've paid across their orders, less refunds.

Value in"createdAt""spent"
sortDirection?string
Value in"asc""desc"

Response Body

Success

application/json
  1. response
items*array<>
total*number
page*number
perPage*number
hasMore*boolean
Example Request
curl -X GET 'https://api-prood.vercel.app/v1/admin/customers'
Example Response
{  "items": [    {      "id": "string",      "email": "string",      "firstName": "string",      "lastName": "string",      "phone": "string",      "addresses": [        {          "id": "string",          "firstName": "string",          "lastName": "string",          "phone": "string",          "street": "string",          "street2": "string",          "city": "string",          "state": "string",          "country": "string",          "postalCode": "string",          "isDefault": true        }      ],      "defaultAddressId": "string",      "createdAt": "string",      "updatedAt": "string",      "orderCount": -9007199254740991,      "spent": 0    }  ],  "total": 0,  "page": 0,  "perPage": 0,  "hasMore": true}