Get - API

Search…
Get
Retrieve a list of your subscriptions
Parameters:
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
Demo
 URL Find your token on - yumpu.com Token 
Optional parameters:
 q  offset  limit  sort  return_fields 
Add optional parametersRun request
1
​
Copied!
curl
PHP
JavaScript
Java
Example:
1
curl -X GET -H "X-ACCESS-TOKEN: YOUR_ACCESS_TOKEN" "https://api.yumpu.com/2.0/account/subscriptions.json?limit=2&offset=0"
Copied!
Example:
1
require_once('../yumpu.php');
2
$yumpu = new Yumpu();
3
$data = array(
4
    'limit' => 2,
5
    'offset' => 0
6
);
7
$listSubscriptions = $yumpu->getSubscriptions($data);
8
print_r($listSubscriptions);
Copied!
Example:
1
var yumpu = require('yumpu');
2
yumpu.setToken('yourToken');
3
var parameters = {
4
  limit: 2,
5
  offset: 0
6
};
7
yumpu.getSubscriptions(parameters, function(statusCode, document){
8
   console.log('Status: ' + statusCode);
9
   console.log(document);
10
});
Copied!
Example:
1
Yumpu y = new Yumpu("your access token");
2
String[] params = {"limit=2", "offset=0"};
3
System.out.println(y.getSubscriptions(params));
Copied!
Whatever language you are using, the result will be the same.
1
{
2
  "total": "5",
3
  "subscriptions": [
4
    {
5
      "id": "QOjiaWfWYWd7TBHE",
6
      "create_date": "2015-01-27 13:21:37",
7
      "update_date": "0000-00-00 00:00:00",
8
      "itc_product_id": "subscription1",
9
      "name": "subscription1",
10
      "description": "subscription1",
11
      "duration": "365",
12
      "kiosks": [
13
        {
14
          "id": "72",
15
          "type": "appkiosk"
16
        }
17
      ]
18
    },
19
    {
20
      "id": "Xzb3GYb5dzimC3Ww",
21
      "create_date": "2015-01-27 09:58:17",
22
      "update_date": "0000-00-00 00:00:00",
23
      "itc_product_id": "subscription2",
24
      "name": "subscription2",
25
      "description": "subscription2",
26
      "duration": "93",
27
      "kiosks": [
28
        {
29
          "id": "72",
30
          "type": "appkiosk"
31
        }
32
      ]
33
    },
34
    {
35
      ...
36
    }
37
  ],
38
  "state": "success",
39
  "completed_in": "0.0316"
40
}
Copied!
API - Previous
Subscriptions
Next - API
Subscription
Last modified 4mo ago
Copy link
Contents
Retrieve a list of your subscriptions
Parameters:
Demo