get_all_customers
Retrieve all customer data from BigCommerce with advanced filtering by email, name, company, phone, dates, and customer groups for comprehensive customer management.
Instructions
Get all customers from the BigCommerce API with comprehensive filtering options (email, name, company, phone, customer group, dates, pagination). Store hash is automatically retrieved from environment variables.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| company | No | Filter by company name (exact match). | |
| customer_group_id | No | Filter by customer group ID (comma-separated for multiple groups). | |
| date_created | No | Filter by exact customer creation date (ISO format: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS). | |
| date_created_max | No | Filter customers created before this date (ISO format: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS). | |
| date_created_min | No | Filter customers created after this date (ISO format: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS). | |
| date_modified | No | Filter by exact customer modification date (ISO format: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS). | |
| date_modified_max | No | Filter customers modified before this date (ISO format: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS). | |
| date_modified_min | No | Filter customers modified after this date (ISO format: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS). | |
| No | Filter by customer email address (exact match). | ||
| id | No | Filter by customer IDs (comma-separated for multiple IDs, e.g., "1,2,3"). | |
| include | No | Include additional customer sub-resources (comma-separated: addresses, storecredit, attributes, formfields). | |
| limit | No | Number of results to return (max 250, default 50). | |
| name | No | Filter by customer full name (exact match). | |
| name_like | No | Filter by customer name using partial match (substring search). | |
| page | No | Page number for pagination (default 1). | |
| phone | No | Filter by phone number (exact match). | |
| registration_ip_address | No | Filter by registration IP address (exact match). | |
| sort | No | Sort field and direction (e.g., "date_created:desc", "last_name:asc", "date_modified:desc"). | |
| store_Hash | No | Optional store hash. If not provided, uses BIGCOMMERCE_STORE_HASH from environment variables. |