A
A
API
Search…
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
1
Copied!
curl
PHP
JavaScript
Java
Example:
1
curl -X GET -H "X-ACCESS-TOKEN: YOUR_ACCESS_TOKEN" "http://api.yumpu.com/2.0/documents.json?offset=0&limit=1&sort=desc"
Copied!
Example:
1
require_once('../yumpu.php');
2
$yumpu = new Yumpu();
3
$data = array(
4
'limit' => 1,
5
'offset' => 0
6
);
7
$listDocument = $yumpu->getDocuments($data);
8
print_r($listDocument);
Copied!
Example:
1
var yumpu = require('yumpu');
2
yumpu.setToken('yourToken');
3
var parameters = {
4
offset: 0,
5
limit: 1
6
};
7
yumpu.getDocuments(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=1"};
3
System.out.println(y.getDocuments(params));
Copied!
Whatever language you are using, the result will be the same.
1
{
2
"total": 6,
3
"documents": [
4
{
5
"id": 55919352,
6
"url": "https://www.yumpu.com/de/document/view/55919352/new-document",
7
"short_url": "https://www.yumpu.com/s/ZYbPdhmifFHwWAc7",
8
"image": {
9
"small": "https://img.yumpu.com/55919352/1/115x163/new-document.jpg",
10
"medium": "https://img.yumpu.com/55919352/1/452x640/new-document.jpg",
11
"big": "https://img.yumpu.com/55919352/1/1129x1600/new-document.jpg"
12
},
13
"language": "de",
14
"title": "New Document",
15
"description": "",
16
"tags": [
17
"suchparameter",
18
"liefert",
19
"google",
20
"webseiten",
21
"suchbegriff",
22
"mehreren",
23
"angezeigt",
24
"beschreibung",
25
"nutzwert",
26
"treffer",
27
"www.lukasbals.at"
28
],
29
"embed_code": "<iframe width=\"512px\" height=\"384px\" src=\"https://www.yumpu.com/de/embed/view/eolzBvCjm84bxPpn\" frameborder=\"0\" allowfullscreen=\"true\" allowtransparency=\"true\"></iframe>"
30
}
31
],
32
"state": "success",
33
"completed_in": 0.0327
34
}
Copied!
Last modified 6mo ago