| Parameter |
Label |
Required |
Options |
Description |
| ids |
Customer Id(s) - Comma separated |
NO |
|
Restrict results to records specified by a comma-separated list of IDs. Max IDs per request controlled by BatchSize property (found in PaginationParams)
|
| since_id |
Since Customer Id |
NO |
|
Restrict results to those created after the specified customer ID.
|
| created_at_max |
Created Before |
NO |
| Option |
Value |
| today |
today |
| yesterday |
yesterday |
| monthstart |
monthstart |
| monthend |
monthend |
| yearstart |
yearstart |
| yearend |
yearend |
| weekstart |
weekstart |
| weekend |
weekend |
| yearstart-1y |
yearstart-1y |
| yearend-1y |
yearend-1y |
| monthstart-1d |
monthstart-1d |
| monthend+1d |
monthend+1d |
|
Restrict results to customers created before a specified date. (format: 2014-04-25T16:15:47). Supported options are the following: now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3 days from month start)
|
| created_at_min |
Created After |
NO |
| Option |
Value |
| today |
today |
| yesterday |
yesterday |
| monthstart |
monthstart |
| monthend |
monthend |
| yearstart |
yearstart |
| yearend |
yearend |
| weekstart |
weekstart |
| weekend |
weekend |
| yearstart-1y |
yearstart-1y |
| yearend-1y |
yearend-1y |
| monthstart-1d |
monthstart-1d |
| monthend+1d |
monthend+1d |
|
Restrict results to customers created after a specified date. (format: 2014-04-25T16:15:47). Supported options are the following: now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3 days from month start)
|
| updated_at_max |
Updated Before |
NO |
| Option |
Value |
| today |
today |
| yesterday |
yesterday |
| monthstart |
monthstart |
| monthend |
monthend |
| yearstart |
yearstart |
| yearend |
yearend |
| weekstart |
weekstart |
| weekend |
weekend |
| yearstart-1y |
yearstart-1y |
| yearend-1y |
yearend-1y |
| monthstart-1d |
monthstart-1d |
| monthend+1d |
monthend+1d |
|
Restrict results to customers last updated before a specified date. (format: 2014-04-25T16:15:47). Supported options are the following: now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3 days from month start)
|
| updated_at_min |
Updated After |
NO |
| Option |
Value |
| today |
today |
| yesterday |
yesterday |
| monthstart |
monthstart |
| monthend |
monthend |
| yearstart |
yearstart |
| yearend |
yearend |
| weekstart |
weekstart |
| weekend |
weekend |
| yearstart-1y |
yearstart-1y |
| yearend-1y |
yearend-1y |
| monthstart-1d |
monthstart-1d |
| monthend+1d |
monthend+1d |
|
Restrict results to customers last updated after a specified date. (format: 2014-04-25T16:15:47). Supported options are the following: now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3 days from month start)
|
| limit |
Page Size |
NO |
|
The maximum number of records to show.
|
| fields |
Only Fields to Show |
NO |
| Option |
Value |
| id |
id |
| email |
email |
| accepts_marketing |
accepts_marketing |
| created_at |
created_at |
| updated_at |
updated_at |
| first_name |
first_name |
| last_name |
last_name |
| orders_count |
orders_count |
| state |
state |
| total_spent |
total_spent |
| last_order_id |
last_order_id |
| note |
note |
| verified_email |
verified_email |
| multipass_identifier |
multipass_identifier |
| tax_exempt |
tax_exempt |
| tags |
tags |
| last_order_name |
last_order_name |
| currency |
currency |
| phone |
phone |
| accepts_marketing_updated_at |
accepts_marketing_updated_at |
| marketing_opt_in_level |
marketing_opt_in_level |
| sms_marketing_consent |
sms_marketing_consent |
| admin_graphql_api_id |
admin_graphql_api_id |
|
Limit data retrieval to only the selected customer-related fields.
|
