List all customers
GET /customers
GET
/customers
Retrieve a paginated list of all customers in a company
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ” page
integer
page_size
integer
is_active
boolean
archived
boolean
Responses
Section titled “ Responses ”List of customers
object
data
Array
total
integer
page
integer
page_size
integer
has_more
boolean
data
Array<object>
object
id
string
external_id
string | null
company_id
string
first_name
string | null
last_name
string | null
name
string | null
metadata
object
email_notifications
boolean
text_notifications
boolean
phone_notifications
boolean
email
string format: email
contact_email
string format: email
text_number
string
phone_number
string
time_window
string
start_time
string
end_time
string
po_required
boolean
date_created
string | null format: date-time
date_modified
string | null format: date-time
timezone
string | null
is_active
boolean
preferences
object | null
archived
boolean
sales_reps
array | null
credit_status
string | null
organizations
array | null
default_payment_type
string | null
profile_id
string | null
area
string | null
units
array | null
delivery_fee_exempt
boolean | null
class_1
string | null
last_modified_date
string | null format: date-time
Unauthorized
object
success
required
boolean
error
required
string
Example
An error occurred