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)

limit

optional

Integer

Retrieve X rows (min. 0 and max. 100)

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 - 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/embeds.json?offset=0&limit=5&sort=desc&return_fields=id,code"

Example:

require_once('../yumpu.php');
$yumpu = new Yumpu();
$data = array(
    'limit' => 2,
    'offset' => 0,
    'sort' => 'desc',
    'return_fields' => 'id,code'
);
$listEmbeds = $yumpu->getEmbeds($data);
print_r($listEmbeds);

Example:

var yumpu = require('yumpu');
yumpu.setToken('yourToken');
var parameters = {
  offset: 0,
  limit: 2,
  sort: 'desc',
  return_fields: 'id,code'
};
yumpu.getEmbeds(parameters, function(statusCode, document){
   console.log('Status: ' + statusCode);
   console.log(document);
});

Example:

Yumpu y = new Yumpu("your access token");
String[] params = {"limit=2", "offset=0", "sort=desc", "return_fields=id,code"};
System.out.println(y.getEmbeds(params));

Whatever language you are using, the result will be the same.

{
  "total": 481,
  "embeds": [
    {
      "id": "zwU3OPgTkL7SCfDj",
      "code": "<iframe width=\"620px\" height=\"566px\" src=\"https://www.yumpu.com/en/embed/view/zwU3OPgTkL7SCfDj\" frameborder=\"0\" allowfullscreen=\"true\" allowtransparency=\"true\"></iframe>"
    },
    {
      "id": "zxaNBp4k12QCMvlP",
      "code": "<iframe width=\"64px\" height=\"64px\" src=\"https://www.yumpu.com/en/embed/view/zxaNBp4k12QCMvlP\" frameborder=\"0\" allowfullscreen=\"true\" allowtransparency=\"true\"></iframe>"
    }
  ],
  "state": "success",
  "completed_in": 0.177
}

PreviousEmbeds NextEmbed

Last updated 3 years ago

Was this helpful?

Retrieve a list of your embeds

Parameters:

Name

Optional / Required

Data type

Description

Default

offset

optional

Integer

Retrieve rows at position X (min. 0)

limit

optional

Integer

Retrieve X rows (min. 0 and max. 100)

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 - 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/embeds.json?offset=0&limit=5&sort=desc&return_fields=id,code"

Example:

require_once('../yumpu.php');
$yumpu = new Yumpu();
$data = array(
    'limit' => 2,
    'offset' => 0,
    'sort' => 'desc',
    'return_fields' => 'id,code'
);
$listEmbeds = $yumpu->getEmbeds($data);
print_r($listEmbeds);

Example:

var yumpu = require('yumpu');
yumpu.setToken('yourToken');
var parameters = {
  offset: 0,
  limit: 2,
  sort: 'desc',
  return_fields: 'id,code'
};
yumpu.getEmbeds(parameters, function(statusCode, document){
   console.log('Status: ' + statusCode);
   console.log(document);
});

Example:

Yumpu y = new Yumpu("your access token");
String[] params = {"limit=2", "offset=0", "sort=desc", "return_fields=id,code"};
System.out.println(y.getEmbeds(params));

Whatever language you are using, the result will be the same.

{
  "total": 481,
  "embeds": [
    {
      "id": "zwU3OPgTkL7SCfDj",
      "code": "<iframe width=\"620px\" height=\"566px\" src=\"https://www.yumpu.com/en/embed/view/zwU3OPgTkL7SCfDj\" frameborder=\"0\" allowfullscreen=\"true\" allowtransparency=\"true\"></iframe>"
    },
    {
      "id": "zxaNBp4k12QCMvlP",
      "code": "<iframe width=\"64px\" height=\"64px\" src=\"https://www.yumpu.com/en/embed/view/zxaNBp4k12QCMvlP\" frameborder=\"0\" allowfullscreen=\"true\" allowtransparency=\"true\"></iframe>"
    }
  ],
  "state": "success",
  "completed_in": 0.177
}