Get - API

Search…
Get
Retrieve a list of your access tags
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, name, description, default, iap, kiosks, create_date, update_date)
id, name, description, default, iap, 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/access_tags.json"
Copied!
Example:
1
require_once('../yumpu.php');
2
$yumpu = new Yumpu();
3
$data = array(
4
    'limit' => 2,
5
    'offset' => 0
6
);
7
$listAccessTags = $yumpu->getAccessTags($data);
8
print_r($listAccessTags);
Copied!
Example:
1
var yumpu = require('yumpu');
2
yumpu.setToken('yourToken');
3
var parameters = {
4
  limit: 2,
5
  offset: 0
6
};
7
yumpu.getAccessTags(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.getAccessTags(params));
Copied!
Whatever language you are using, the result will be the same.
1
{
2
  "total": "6",
3
  "access_tags": [
4
    {
5
      "id": "HnD4YrKMeGjxH3xT",
6
      "create_date": "2015-01-27 08:54:41",
7
      "update_date": "0000-00-00 00:00:00",
8
      "name": "accesstag1",
9
      "description": "accesstag1",
10
      "default": false,
11
      "iap": true,
12
      "kiosks": [
13
        {
14
          "id": "72",
15
          "type": "appkiosk"
16
        }
17
      ]
18
    },
19
    {
20
      "id": "WkrKvPxsOAqziqGf",
21
      "create_date": "2015-01-14 10:09:09",
22
      "update_date": "0000-00-00 00:00:00",
23
      "name": "accesstag2",
24
      "description": "accesstag2",
25
      "default": false,
26
      "iap": false,
27
      "kiosks": [
28
        {
29
          "id": "72",
30
          "type": "appkiosk"
31
        },
32
        {
33
          "id": "860",
34
          "type": "appkiosk"
35
        },
36
        {
37
          "id": "960",
38
          "type": "appkiosk"
39
        }
40
      ]
41
    },
42
      ...
43
    }
44
  ],
45
  "state": "success",
46
  "completed_in": "0.0315"
47
}
Copied!
API - Previous
Access tags
Next - API
Access tag
Last modified 4mo ago
Copy link
Contents
Retrieve a list of your access tags
Parameters:
Demo