Name | Optional / Required | Data type | Description | Default |
q | optional | String | A keyword to search for | ​ |
offset | optional | Integer | Retrieve rows at position X (min. 0) | 0 |
limit | optional | Integer | Retrieve X rows (min. 0 and max. 100) | 10 |
sort | optional | String | Sort results by create_date ascendending / descending (create_date_asc, create_date_desc) or name ascendending / descending (name_asc, name_desc) | create_date_desc |
return_fields | optional | String | Customize the responses by setting the return fields (id, itc_product_id, name, description, duration, kiosks, create_date, update_date) | id, itc_product_id, name, description, duration, kiosks, create_date, update_date |
URL Find your token on - yumpu.com Token
q offset limit sort return_fields
Add optional parametersRun request
​
Example:
curl -X GET -H "X-ACCESS-TOKEN: YOUR_ACCESS_TOKEN" "http://api.yumpu.com/2.0/account/subscriptions.json?limit=2&offset=0"
Example:
require_once('../yumpu.php');$yumpu = new Yumpu();$data = array('limit' => 2,'offset' => 0);$listSubscriptions = $yumpu->getSubscriptions($data);print_r($listSubscriptions);
Example:
var yumpu = require('yumpu');yumpu.setToken('yourToken');var parameters = {limit: 2,offset: 0};yumpu.getSubscriptions(parameters, function(statusCode, document){console.log('Status: ' + statusCode);console.log(document);});
Example:
Yumpu y = new Yumpu("your access token");String[] params = {"limit=2", "offset=0"};System.out.println(y.getSubscriptions(params));
Whatever language you are using, the result will be the same.
{"total": "5","subscriptions": [{"id": "QOjiaWfWYWd7TBHE","create_date": "2015-01-27 13:21:37","update_date": "0000-00-00 00:00:00","itc_product_id": "subscription1","name": "subscription1","description": "subscription1","duration": "365","kiosks": [{"id": "72","type": "appkiosk"}]},{"id": "Xzb3GYb5dzimC3Ww","create_date": "2015-01-27 09:58:17","update_date": "0000-00-00 00:00:00","itc_product_id": "subscription2","name": "subscription2","description": "subscription2","duration": "93","kiosks": [{"id": "72","type": "appkiosk"}]},{...}],"state": "success","completed_in": "0.0316"}