Get - API

Search…
Get
Retrieve an existing embed
Parameters:
Name
Optional / Required
Data type
Description
Default
id
required
String
One of your embed ids
​
return_fields
optional
String
Customize the responses by setting the return fields ('id', 'user_id', 'document_id', 'type', 'create_date', 'code', 'settings')
'id', 'user_id', 'document_id', 'type', 'create_date', 'code', 'settings'
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" "https://api.yumpu.com/2.0/embed.json?id=zKtHE23d6R0qT1rf"
Copied!
Example:
1
require_once('../yumpu.php');
2
$yumpu = new Yumpu();
3
$data = array(
4
    'id' => 'zKtHE23d6R0qT1rf',
5
);
6
$listEmbed = $yumpu->getEmbed($data);
7
print_r($listEmbed);
Copied!
Example:
1
var yumpu = require('yumpu');
2
yumpu.setToken('yourToken');
3
var parameters = {
4
  id: 'zKtHE23d6R0qT1rf'
5
};
6
yumpu.getEmbed(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=zKtHE23d6R0qT1rf"};
3
System.out.println(y.getEmbed(params));
Copied!
Whatever language you are using, the result will be the same.
1
{
2
  "embed": {
3
    "id": "zKtHE23d6R0qT1rf",
4
    "user_id": 10000,
5
    "document_id": "11199",
6
    "type": "4",
7
    "create_date": "2014-12-03 10:57:49",
8
    "code": "iframe",
9
    "settings": {
10
      "background_color": 253139,
11
      "destination": "https://www.yumpu.com",
12
      "download_pdf_enabled": 1,
13
      "height": "100",
14
      "start_page": 1,
15
      "text_font_color": "0082b2",
16
      "text_font_family": "ABeeZee:regular:latin",
17
      "text_font_size": 14,
18
      "text_font_style": "off",
19
      "text_font_weight": "off",
20
      "width": "100"
21
    }
22
  },
23
  "state": "success",
24
  "completed_in": "0.0665"
25
}
Copied!
API - Previous
Embed
Post
Last modified 4mo ago
Copy link
Contents
Retrieve an existing embed
Parameters:
Demo