List Customers

Page number (page will be ignored if you provide before or after in the request). For example page=1.

Items count per page. limit=50

Filter items by ID. id:in=4,5,6

Filter items by company. company:in=bigcommerce,commongood

Filter items by customer_group_id. customer_group_id:in=5,6

Filter items by date created, for example, 2024-05-14T09:34:00 or 2024-05-14.

Filter items by maximum date created, for example, 2024-05-14T09:34:00 or 2024-05-14. Returns customers created before this date.

Filter items by date created for example, 2024-05-14T09:34:00 or 2024-05-14. Returns customers created after this date.

Filter items by date modified, for example, 2024-05-14T09:34:00 or 2024-05-14.

Filter items by minimum date modified, for example, 2024-05-14T09:34:00 or 2024-05-14. Returns customers modified after this date.

Filter items by maximum date modified, for example, 2024-05-14T09:34:00 or 2024-05-14. Returns customers modified before this date.

Filter items by email. email:in=janedoe@example.com

Filter items by first_name and last_name. name=james moriarty

Filter items by substring in first_name and last_name. name:like=moriarty,sherlock Concatenates the first_name and last_name fields.

Filter items by phone number. phone:in=555-55-5555

Filter items by registration_ip_address. If the customer was created using the API, then registration address is blank. registration_ip_address:in=12.345.6.789

The cursor reference of the last entry for the previous page. Use the end_cursor value from the last response to get the next page (end_cursor is only returned on the first page or when the request contains query parameter before or after). For example after=eyJpZCI6MjA0fQ.

The cursor reference of the first entry for the next page. Use the start_cursor value from the last response to get the previous page (start_cursor is only returned on the first page or when the request contains query parameter before or after). For example before=eyJpZCI6MjA1fQ.