curl --request GET \
--url https://api.komerza.com/stores/{storeId}/customers/search/{query} \
--header 'Authorization: Bearer <token>'{
"success": true,
"pages": 123,
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dateCreated": "2023-11-07T05:31:56Z",
"emailAddress": "<string>",
"status": "<string>",
"isAffiliate": true,
"totalSpend": 123,
"averageSpend": 123,
"totalOrders": 123
}
]
}Retrieves a paginated list of customers for the specified store, matching the provided query.
Requires the stores.customers.view permission.
curl --request GET \
--url https://api.komerza.com/stores/{storeId}/customers/search/{query} \
--header 'Authorization: Bearer <token>'{
"success": true,
"pages": 123,
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dateCreated": "2023-11-07T05:31:56Z",
"emailAddress": "<string>",
"status": "<string>",
"isAffiliate": true,
"totalSpend": 123,
"averageSpend": 123,
"totalOrders": 123
}
]
}Your API key goes here
The query to search by
The ID of the store whose customers to retrieve.
Filter by email address (case-insensitive contains).
Filter by the IP address the customer used (case-insensitive contains).
Minimum balance (inclusive).
Maximum balance (inclusive).
Filter by Stripe customer ID (exact match).
Filter by the store-affiliate’s code (case-insensitive contains).
1 <= x <= 21474836471 <= x <= 2147483647The object was successfully returned.
Represents a paginated response returned from API endpoints, which contains the paginated data and metadata about the pagination.
Was this page helpful?