EndPoint Get Customers

Contents

1 Label
2 Description
3 Parameters
4 Output Columns
5 Input Columns

Name

get_customers

Description

Gets a list of customers. [API Help]

Parameters

Parameter

Label

Required

Options

Description

ids

Customer Id(s) - Comma separated

Restrict results to records specified by a comma-separated list of IDs.

since_id

Since Customer Id

Restrict results to those created after the specified customer ID.

created_at_max

Created Before

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

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

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

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

The maximum number of records to show.

fields

Only Fields to Show

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.

Output Columns

Label	DataType	Length	Raw
Id	DT_I8	0	False
Email	DT_WSTR	255	False
AcceptsMarketing	DT_BOOL	0	False
CreatedAt	DT_DBTIMESTAMP	0	False
UpdatedAt	DT_DBTIMESTAMP	0	False
FirstName	DT_WSTR	255	False
LastName	DT_WSTR	255	False
OrdersCount	DT_I4	0	False
State	DT_WSTR	255	False
TotalSpent	DT_WSTR	50	False
LastOrderId	DT_I8	0	False
Note	DT_WSTR	4000	False
VerifiedEmail	DT_BOOL	0	False
MultipassIdentifier	DT_WSTR	255	False
TaxExempt	DT_BOOL	0	False
TaxExemptions	DT_WSTR	4000	True
Tags	DT_WSTR	4000	False
LastOrderName	DT_WSTR	255	False
Currency	DT_WSTR	20	False
Phone	DT_WSTR	30	False
AcceptsMarketingUpdatedAt	DT_DBTIMESTAMP	0	False
MarketingOptInLevel	DT_WSTR	255	False
SMSMarketingConsent	DT_WSTR	255	False
AdminGraphQLApiId	DT_WSTR	255	False
DefaultAddressId	DT_WSTR	255	False
DefaultAddressCustomerId	DT_WSTR	255	False
DefaultAddressFirstName	DT_WSTR	255	False
DefaultAddressLastName	DT_WSTR	255	False
DefaultAddressCompany	DT_WSTR	255	False
DefaultAddressAddress1	DT_WSTR	255	False
DefaultAddressAddress2	DT_WSTR	255	False
DefaultAddressCity	DT_WSTR	255	False
DefaultAddressProvince	DT_WSTR	255	False
DefaultAddressCountry	DT_WSTR	255	False
DefaultAddressZip	DT_WSTR	255	False
DefaultAddressPhone	DT_WSTR	255	False
DefaultAddressName	DT_WSTR	255	False
DefaultAddressProvinceCode	DT_WSTR	255	False
DefaultAddressCountryCode	DT_WSTR	255	False
DefaultAddressCountryName	DT_WSTR	255	False
EmailMarketingConsentState	DT_WSTR	255	False
EmailMarketingConsentOptInLevel	DT_WSTR	255	False
EmailMarketingConsentUpdatedAt	DT_DBTIMESTAMP	0	False

Input Columns

Label	DataType	Length	Raw	Description
CustomerId	DT_I8	0	False