Get

Retrieve a list of your access tags

Parameters:

Name

Optional / Required

Data type

Description

Default

optional

String

A keyword to search for

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 by create_date ascendending / descending (create_date_asc, create_date_desc) or name ascendending / descending (name_asc, name_desc)

create_date_desc

return_fields

optional

String

Customize the responses by setting the return fields (id, name, description, default, iap, kiosks, create_date, update_date)

id, name, description, default, iap, kiosks, create_date, update_date

Demo

URL Find your token on - yumpu.com Token

Optional parameters:

q 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/account/access_tags.json"

Example:

var yumpu = require('yumpu');
yumpu.setToken('yourToken');
var parameters = {
  limit: 2,
  offset: 0
};
yumpu.getAccessTags(parameters, function(statusCode, document){
   console.log('Status: ' + statusCode);
   console.log(document);
});

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

{
  "total": "6",
  "access_tags": [
    {
      "id": "HnD4YrKMeGjxH3xT",
      "create_date": "2015-01-27 08:54:41",
      "update_date": "0000-00-00 00:00:00",
      "name": "accesstag1",
      "description": "accesstag1",
      "default": false,
      "iap": true,
      "kiosks": [
        {
          "id": "72",
          "type": "appkiosk"
        }
      ]
    },
    {
      "id": "WkrKvPxsOAqziqGf",
      "create_date": "2015-01-14 10:09:09",
      "update_date": "0000-00-00 00:00:00",
      "name": "accesstag2",
      "description": "accesstag2",
      "default": false,
      "iap": false,
      "kiosks": [
        {
          "id": "72",
          "type": "appkiosk"
        },
        {
          "id": "860",
          "type": "appkiosk"
        },
        {
          "id": "960",
          "type": "appkiosk"
        }
      ]
    },
      ...
    }
  ],
  "state": "success",
  "completed_in": "0.0315"
}

PreviousAccess tags NextAccess tag

Last updated 3 years ago

hashtagRetrieve a list of your access tags

hashtagParameters:

hashtagDemo

hashtagOptional parameters:

Retrieve a list of your access tags

Parameters:

Demo

Optional parameters: