Skip to content

List all profiles

GET
/api/profiles
page
number
limit
number
search
string
email
string
email_status
string
Allowed values: subscribed unsubscribed suppressed
shopify_customer_id
string
object
data
required
Array<object>
object
id
required
string
timezone
string
nullable
address1
string
nullable
address2
string
nullable
city
string
nullable
region
string
nullable
country
string
nullable
postal_code
string
nullable
created_at
string
nullable
updated_at
string
nullable
full_address
required
string
email_status
One of:
string
nullable
email
required
string
external_id
string
nullable
first_name
string
nullable
last_name
string
nullable
full_name
required
string
phone_number
string
nullable
sms_status
One of:
string
nullable
shopify_customer_id
string
nullable
meta
required
object
total

Total number of items

number
per_page

Items per page

number
current_page

Current page number

number
last_page

Last page number

number
first_page

First page number

number
first_page_url

URL for first page

string
last_page_url

URL for last page

string
next_page_url

URL for next page

string
nullable
previous_page_url

URL for previous page

string
nullable