|
Type
|
List
|
|
List
|
Companies
|
|
URL
|
http://{domain}/api/v2/companies.json
|
|
Accepts Filters
|
Yes
|
Output Attributes
|
No
|
List Companies
Gets the filtered list of companies.
Filters
Filter the companies into a list. Company Attributes are available as a filter.
|
Parameter
|
Type
|
Rules
|
Example
|
|
status
|
int
|
0,1 or 2
|
1
|
|
display_id
|
int
|
|
1000
|
|
name
|
string
|
Company Name
|
ABC Company
|
|
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",
"name": "Bob's Flower Shop",
"status": "1"
},
{
"id": "4",
"name": "Joe's Bicycle Shop",
"status": "1"
},
{
"id": "3",
"name": "XYZ Company, Inc.",
"status": "1"
},
{
"id": "2",
"name": "Coffee Shop Company",
"status": "1"
},
{
"id": "1",
"name": "Sam's Super Gym",
"status": "1"
}
]
}
© 2017 Lead Commerce, LLC · All rights reserved · 
Made with ❤ in the USA.
