Get - API

Search…
Get
Retrieve a list of your members
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 username ascendending / descending (username_asc, username_desc)
create_date_desc
return_fields
optional
String
Customize the responses by setting the return fields ('id', 'username', 'comment', 'password', 'access_tags', 'kiosks', 'create_date', 'update_date')
'id', 'username', 'comment', 'password', 'access_tags', '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/members.json"
Copied!
Example:
1
require_once('../yumpu.php');
2
$yumpu = new Yumpu();
3
$data = array(
4
    'limit' => 2,
5
    'offset' => 0
6
);
7
$listMembers = $yumpu->getMembers($data);
8
print_r($listMembers);
Copied!
Example:
1
var yumpu = require('yumpu');
2
yumpu.setToken('yourToken');
3
var parameters = {
4
  offset: 0,
5
  limit: 2
6
};
7
yumpu.getMembers(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.getMembers(params));
Copied!
Whatever language you are using, the result will be the same.
1
{
2
  "total": "6",
3
  "members": [
4
    {
5
      "id": "vGbxpwFZuvvdAGnS",
6
      "create_date": "2014-11-03 12:59:52",
7
      "update_date": "0000-00-00 00:00:00",
8
      "username": "user1",
9
      "password": "password",
10
      "comment": "user1",
11
      "access_tags": [
12
        {
13
          "id": "zxeeYReHnxeg8RqZ",
14
          "name": "accesstag1",
15
          "default": true
16
        }
17
      ],
18
      "kiosks": [
19
        {
20
          "id": "1572",
21
          "type": "webkiosk"
22
        }
23
      ]
24
    },
25
    {
26
      "id": "uBrURwzHMBEe32Dj",
27
      "create_date": "2014-10-08 17:10:39",
28
      "update_date": "0000-00-00 00:00:00",
29
      "username": "user2",
30
      "password": "password",
31
      "comment": "user2",
32
      "access_tags": [
33
        {
34
          "id": "zxeeYReHnxeg8RqZ",
35
          "name": "accesstag1",
36
          "default": true
37
        }
38
      ],
39
      "kiosks": [
40
        {
41
          "id": "25",
42
          "type": "webkiosk"
43
        },
44
        {
45
          "id": "860",
46
          "type": "appkiosk"
47
        }
48
      ]
49
    },
50
    {
51
      ...
52
    }
53
  ],
54
  "state": "success",
55
  "completed_in": "0.0608"
56
}
Copied!
API - Previous
Members
Next - API
Member
Last modified 4mo ago
Copy link
Contents
Retrieve a list of your members
Parameters:
Demo