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

curl
PHP
JavaScript
Java
curl

Example:

curl -X GET -H "X-ACCESS-TOKEN: YOUR_ACCESS_TOKEN" "http://api.yumpu.com/2.0/account/members.json"
PHP

Example:

require_once('../yumpu.php');
$yumpu = new Yumpu();
$data = array(
'limit' => 2,
'offset' => 0
);
$listMembers = $yumpu->getMembers($data);
print_r($listMembers);
JavaScript

Example:

var yumpu = require('yumpu');
yumpu.setToken('yourToken');
var parameters = {
offset: 0,
limit: 2
};
yumpu.getMembers(parameters, function(statusCode, document){
console.log('Status: ' + statusCode);
console.log(document);
});
Java

Example:

Yumpu y = new Yumpu("your access token");
String[] params = {"limit=2", "offset=0"};
System.out.println(y.getMembers(params));

Whatever language you are using, the result will be the same.

{
"total": "6",
"members": [
{
"id": "vGbxpwFZuvvdAGnS",
"create_date": "2014-11-03 12:59:52",
"update_date": "0000-00-00 00:00:00",
"username": "user1",
"password": "password",
"comment": "user1",
"access_tags": [
{
"id": "zxeeYReHnxeg8RqZ",
"name": "accesstag1",
"default": true
}
],
"kiosks": [
{
"id": "1572",
"type": "webkiosk"
}
]
},
{
"id": "uBrURwzHMBEe32Dj",
"create_date": "2014-10-08 17:10:39",
"update_date": "0000-00-00 00:00:00",
"username": "user2",
"password": "password",
"comment": "user2",
"access_tags": [
{
"id": "zxeeYReHnxeg8RqZ",
"name": "accesstag1",
"default": true
}
],
"kiosks": [
{
"id": "25",
"type": "webkiosk"
},
{
"id": "860",
"type": "appkiosk"
}
]
},
{
...
}
],
"state": "success",
"completed_in": "0.0608"
}