Get
/box/customer/v1/customers
Get a list of customers either with or without search parameters
Query parameters
filter[id]
string
Search over the provided id
filter[email]
string
Search over the provided email address
filter[name]
string
Search over the provided customer name
page[cursor]
string
Location to start the search from, using cursor based navigation.
page[size]
number
Number of items to return - defaults to 10
Default10
Responses
200
Successful operation
object
data
object (1.0.11_BaseCustomer)
type
string
Valid values[
"CUSTOMER"
]
id
string (uuid)
email
string (email)
firstName
string (name)
lastName
string (name)
createdAt
string (date-time)
updatedAt
string (date-time)
phone
object
countryCode
string
number
string
addresses
Array of object (1.0.11_Address)
object
id
string (uuid)
type
string
Valid values[
"ADDRESS"
]
createdAt
string (date-time)
updatedAt
string (date-time)
line1
string
line2
string
city
string
province
string
zipcode
string
country
string
meta
object
pagination
object
cursor
string
nextCursor
string
400
Invalid format
401
Unauthorized
403
Forbidden
500
Internal error