Get
Retrieve a list of your documents
Parameters:
Name
Optional / Required
Data type
Description
Default
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 ascending or descendening (asc or desc)
desc
return_fields
optional
String
Customize the responses by setting the return fields (id, create_date, update_date, url, read_url, short_url, image_small, image_medium, image_big, language, title, description, tags, embed_code, settings)
id, url, short_url, image_small, image_medium, image_big, language, title, description, tags, embed_code
Demo
URL Find your token on - yumpu.com Token
Optional parameters:
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/documents.json?offset=0&limit=1&sort=desc"Example:
require_once('../yumpu.php');
$yumpu = new Yumpu();
$data = array(
'limit' => 1,
'offset' => 0
);
$listDocument = $yumpu->getDocuments($data);
print_r($listDocument);Example:
var yumpu = require('yumpu');
yumpu.setToken('yourToken');
var parameters = {
offset: 0,
limit: 1
};
yumpu.getDocuments(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?