Get - API

Search…
Get
Retrieve an existing document
Parameters:
Name
Optional / Required
Data type
Description
Default
id
required
Integer
One of your document ids
​
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 
 id 
Optional parameters:
 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/document.json?id=27109085"
Copied!
Example:
1
require_once('../yumpu.php');
2
$yumpu = new Yumpu();
3
$data = array(
4
    'id' => 27109085,
5
    'return_fields' => 'id,create_date,update_date,url,image_small'
6
);
7
$listDocument = $yumpu->getDocument($data);
8
print_r($listDocument);
Copied!
Example:
1
var yumpu = require('yumpu');
2
yumpu.setToken('yourToken');
3
var parameters = {
4
   id: 27109085
5
};
6
yumpu.getDocument(parameters, function(statusCode, document){
7
   console.log('Status: ' + statusCode);
8
   console.log(document);
9
});
Copied!
Example:
1
Yumpu y = new Yumpu("your access token");
2
String[] params = { "id=27109085" };
3
System.out.println(y.getDocument(params));
Copied!
Whatever language you are using, the result will be the same.
1
{
2
  "document": [
3
    {
4
      "id": 55919352,
5
      "create_date": "2016-09-08 14:02:24",
6
      "update_date": "2016-09-08 14:03:03",
7
      "url": "https://www.yumpu.com/de/document/view/55919352/new-document",
8
      "image": {
9
        "small": "https://img.yumpu.com/55919352/1/115x163/new-document.jpg"
10
      }
11
    }
12
  ],
13
  "state": "success",
14
  "completed_in": 0.0562
15
}
Copied!
API - Previous
Document
Post file
Last modified 10mo ago
Copy link
Contents
Retrieve an existing document
Parameters:
Demo