|
Type
|
List
|
|
List
|
Customers
|
|
URL
|
http://{domain}/api/v2/customers.json
|
|
Accepts Filters
|
Yes
|
Output Attributes
|
No
|
List Customers
Gets the filtered list of customers.
Filters
Filter the customers into a list. Customer Attributes are available as a filter.
|
Parameter
|
Type
|
Rules
|
Example
|
|
status
|
int
|
0,1 or 2
|
1
|
|
lead
|
boolean
|
Customer a lead or not
|
false
|
|
display_id
|
int
|
|
1000
|
|
email
|
string
|
|
[email protected]
|
|
username
|
string
|
|
[email protected]
|
|
first
|
string
|
|
Jack
|
|
last
|
string
|
|
Hill
|
|
customer_type
|
int
|
|
2
|
|
company
|
int
|
|
34
|
|
modify_start
|
date
|
|
1431377356
|
|
modify_end
|
date
|
|
1431377356
|
Pagination
Parameters can be added to the CURL call to paginate the List. The maximum limit is 250. By default, this limit is set to 100.
|
Parameter
|
Type
|
Default
|
Example
|
|
limit
|
int
|
1
|
2
|
|
page
|
int
|
1
|
5
|
Response
Example JSON returned
{
"code": "200",
"data": [
{
"id": "5",
"display_id": "1004",
"first_name": "Bob",
"last_name": "Smith",
"email": "[email protected]",
"username": "[email protected]",
"status": "1",
"customer_type": [
{
"id": "1",
"name": "Customer"
}
]
},
{
"id": "2",
"display_id": "1001",
"first_name": "Jon",
"last_name": "Smith",
"email": "[email protected]",
"username": "[email protected]",
"status": "1",
"customer_type": [
{
"id": "1",
"name": "Customer"
}
]
}
]
}
© 2017 Lead Commerce, LLC · All rights reserved · 
Made with ❤ in the USA.
