Get - API

Search…
Get
Retrieve a list of your embeds
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', '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 
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" "https://api.yumpu.com/2.0/embeds.json?offset=0&limit=5&sort=desc&return_fields=id,code"
Copied!
Example:
1
require_once('../yumpu.php');
2
$yumpu = new Yumpu();
3
$data = array(
4
    'limit' => 2,
5
    'offset' => 0,
6
    'sort' => 'desc',
7
    'return_fields' => 'id,code'
8
);
9
$listEmbeds = $yumpu->getEmbeds($data);
10
print_r($listEmbeds);
Copied!
Example:
1
var yumpu = require('yumpu');
2
yumpu.setToken('yourToken');
3
var parameters = {
4
  offset: 0,
5
  limit: 2,
6
  sort: 'desc',
7
  return_fields: 'id,code'
8
};
9
yumpu.getEmbeds(parameters, function(statusCode, document){
10
   console.log('Status: ' + statusCode);
11
   console.log(document);
12
});
Copied!
Example:
1
Yumpu y = new Yumpu("your access token");
2
String[] params = {"limit=2", "offset=0", "sort=desc", "return_fields=id,code"};
3
System.out.println(y.getEmbeds(params));
Copied!
Whatever language you are using, the result will be the same.
1
{
2
  "total": 481,
3
  "embeds": [
4
    {
5
      "id": "zwU3OPgTkL7SCfDj",
6
      "code": "<iframe width=\"620px\" height=\"566px\" src=\"https://www.yumpu.com/en/embed/view/zwU3OPgTkL7SCfDj\" frameborder=\"0\" allowfullscreen=\"true\" allowtransparency=\"true\"></iframe>"
7
    },
8
    {
9
      "id": "zxaNBp4k12QCMvlP",
10
      "code": "<iframe width=\"64px\" height=\"64px\" src=\"https://www.yumpu.com/en/embed/view/zxaNBp4k12QCMvlP\" frameborder=\"0\" allowfullscreen=\"true\" allowtransparency=\"true\"></iframe>"
11
    }
12
  ],
13
  "state": "success",
14
  "completed_in": 0.177
15
}
Copied!
API - Previous
Embeds
Next - API
Embed
Last modified 4mo ago
Copy link
Contents
Retrieve a list of your embeds
Parameters:
Demo