Skip to content

WooCommerce - Get Customers

This module allows querying customers from your WooCommerce store, either a specific customer by ID or a list with search by email, name, or other criteria.

FieldTypeRequiredDescription
credentials_idstringYesCredentials ID
customer_idnumberNoSpecific customer ID
emailstringNoFilter by exact email
searchstringNoText search
rolestringNoFilter by role (customer, subscriber, etc.)
orderbystringNoid, include, name, registered_date
orderstringNoasc, desc
per_pagenumberNoCustomers per page (max 100)
pagenumberNoPage number
FieldDescriptionExample
urlWooCommerce store base URLhttps://my-store.com
consumer_keyREST API Consumer Keyck_xxxx...
consumer_secretREST API Consumer Secretcs_xxxx...
{
"success": true,
"customers": [
{
"id": 123,
"email": "cliente@ejemplo.com",
"first_name": "Juan",
"last_name": "Garcia",
"role": "customer",
"billing": {},
"shipping": {},
"orders_count": 5,
"total_spent": "450.00"
}
],
"total": 150,
"total_pages": 3,
"current_page": 1
}
{
"credentials_id": "woo_tienda",
"email": "cliente@ejemplo.com"
}
{
"credentials_id": "woo_tienda",
"orderby": "registered_date",
"order": "desc",
"per_page": 20
}
  • The maximum limit per request is 100 customers
  • Email search is exact
  • The search field searches in first name, last name, and email
  • Customers include aggregated order information
  • WooCreateCustomer - Create a new customer
  • WooUpdateCustomer - Update customer data
  • WooGetOrders - Get customer orders