API - Rentals - Retrieve List

Request:

GET /api6/rentals/?apiKey=XXXXXX {

pagename: Demo Rentals LLC <--- This is the group name from your page templates

categoryid: 1234 <--- ID of the category you'd like to retrieve all rentals from

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

_prices: true/false <--- returns array of price details by hour

offset: 0 <--- start at record #

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

}

Response:

{

"offset": "",

"limit": "2",

"first": "https://rental.software/api6/rentals?offset=0&limi...

"next": "https://rental.software/api6/rentals?offset=2&limi...

"previous": https://rental.software/api6/rentals?offset=0&limi...

"items": [

{

"id": "1",

"href": "https://rental.software/api6/rentals/1",

"ridename": "11 x 11 Castle Jumper23",

"imageloc": "https://rental.software/images/manufacturers/bounc...

"imagelocbig": "",

"description": ""

},

{

"id": "1169",

"href": "https://rental.software/api6/rentals/1169",

"ridename": "111111111111111",

"imageloc": "",

"imagelocbig": "",

"description": ""

}

]

}

Is article helpful?