younifyd
Menu

List All Customers

This API helps you to view all the customers.

GET/customers

Use it in a workflow

  1. Add a step and choose the WooCommerce connector.
  2. Pick the List All Customers action (under Customers).
  3. Fill in the fields below, then reference the result from later steps as {{listAllCustomers.response.data}}.

Request

Query parameters

contextstring

Scope under which the request is made; determines fields present in response. Options: view and edit. Default is view.

One ofvieweditDefault "view"

pageinteger

Current page of the collection. Default is 1.

Default 1

per_pageinteger

Maximum number of items to be returned in result set. Default is 10.

Default 10

searchstring

Limit results to those matching a string.

excludearray<integer>

Ensure result set excludes specific IDs.

includearray<integer>

Limit result set to specific IDs.

offsetinteger

Offset the result set by a specific number of items.

orderstring

Order sort attribute ascending or descending. Options: asc and desc. Default is asc.

One ofascdescDefault "asc"

orderbystring

Sort collection by object attribute. Options: id, include, name and registered_date. Default is name.

One ofidincludenameregistered_dateDefault "name"

emailstring

Limit result set to resources with a specific email.

rolestring

Limit result set to resources with a specific role. Options: all, administrator, editor, author, contributor, subscriber, customer and shop_manager. Default is customer.

One ofalladministratoreditorauthorcontributorsubscribercustomershop_managerDefault "customer"

Response

Returns 200 with a array<object>. Read it in later steps with {{listAllCustomers.response.data.<field>}}.

Need more? See the WooCommerce guide for connection setup and behaviour shared by every action.

List All Customers — WooCommerce — Documentation