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
Example:
curl -X GET -H "X-ACCESS-TOKEN: YOUR_ACCESS_TOKEN" "https://api.yumpu.com/2.0/account/members.json"Example:
require_once('../yumpu.php');
$yumpu = new Yumpu();
$data = array(
'limit' => 2,
'offset' => 0
);
$listMembers = $yumpu->getMembers($data);
print_r($listMembers);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);
});Example:
Whatever language you are using, the result will be the same.
Last updated
Was this helpful?