API - Customers - Retrieve List

Request:

GET /api6/customers/?apiKey=XXXXXX {

_body: true/false <--- if true, returns more details

offset: 1 <--- start at record #

limit: 2 <--- count of records to return

}


Response:

{

"offset": "1",

"limit": "2",

"first": "https://rental.software/api6/customers?offset=0&limit=2",

"next": "https://rental.software/api6/customers?offset=3&limit=2",

"previous": "https://rental.software/api6/customers?offset=0&limit=2",

"items": [

{

"id": "533295",

"createtime": "2015-09-29T16:47:54-04:00",

"modifiedtime": "2015-09-29T16:47:54-04:00",

"organization": "",

"firstname": "John",

"lastname": "Smith",

"street": "123 Hello St",

"city": "Akron",

"state": "OH",

"zip": "44314",

"country": "",

"homephone": "",

"officephone": "",

"cellphone": "",

"fax": "",

"email": "",

"notes": "",

"customertype": "Commercial",

"locationid": "0",

"href": "https://rental.software/api6/customers/533295",

"createtime_ts": "1443559674",

"createtime_utc": "2015-09-29T20:47:54Z",

"modifiedtime_ts": "1443559674",

"modifiedtime_utc": "2015-09-29T20:47:54Z"

},

{

"id": "533296",

"createtime": "2015-09-29T16:49:10-04:00",

"modifiedtime": "2015-09-29T16:49:28-04:00",

"organization": "",

"firstname": "Billy",

"lastname": "Jones",

"street": "",

"city": "",

"state": "OH",

"zip": "",

"country": "",

"homephone": "",

"officephone": "",

"cellphone": "(231) 231-1234",

"fax": "",

"email": "",

"notes": "",

"customertype": "Commercial",

"locationid": "0",

"href": "https://rental.software/api6/customers/533296",

"createtime_ts": "1443559750",

"createtime_utc": "2015-09-29T20:49:10Z",

"modifiedtime_ts": "1443559768",

"modifiedtime_utc": "2015-09-29T20:49:28Z"

}

]

}

Is this article helpful?
0 0 1