Skip to content

List Customers (Datagrid)

Mirrors the admin Customers → Customers datagrid.

Endpoint

EndpointMethod
/api/admin/customersGET

Query Parameters

ParameterTypeDescription
page, per_pageintegerPagination (default 10, cap 50).
namestringPartial first/last name.
emailstringPartial email.
phonestringPartial phone.
customer_group_idintegerFilter by group ID.
statusinteger0 or 1.
channel_idintegerFilter by channel ID.
date_of_birth_from / _todateDOB range.
created_at_from / _todateCreated range.
sortstringid (default desc), email, first_name.
orderstringasc, desc.

Released under the MIT License.