API
  • Yumpu documentations
  • JS
    • Introduction
    • Quick setup
    • Magazine example's
    • Bookshelf example's
    • FAQs
  • API
    • Introduction
    • Getting started
      • API token
      • Document API
      • User API
      • Search API
      • Install SDK's
    • Limits
    • Flowchart of basic processes
    • Documents
      • Get
    • Document
      • Get
      • Post file
      • Post url
      • Put
      • Delete
    • Document hotspots
      • Get
    • Document hotspot
      • Get
      • Post
      • Put
      • Delete
    • Document progress
      • Get
    • Document categories
      • Get
    • Document languages
      • Get
    • Countries
      • Get
    • Collections
      • Get
    • Collection
      • Get
      • Post
      • Put
      • Delete
    • Section
      • Get
      • Post
      • Put
      • Delete
    • Section document
      • Post
      • Delete
    • Search
      • Get
    • User
      • Get
      • Post
      • Put
    • Embeds
      • Get
    • Embed
      • Get
      • Post
      • Put
      • Delete
    • Members
      • Get
    • Member
      • Get
      • Post
      • Put
      • Delete
    • Access tags
      • Get
    • Access tag
      • Get
      • Post
      • Put
      • Delete
    • Subscriptions
      • Get
    • Subscription
      • Get
      • Post
      • Put
      • Delete
Powered by GitBook
On this page
  • Retrieve your user
  • Parameters:
  • Demo

Was this helpful?

  1. API
  2. User

Get

PreviousUserNextPost

Last updated 3 years ago

Was this helpful?

Retrieve your user

Parameters:

Name

Optional / Required

Data type

Description

Default

return_fields

optional

String

Customize the responses by setting the return fields (id, create_date, activate_date, last_login_date, username, email, gender, name, firstname, lastname, birth_date, address, zip_code, city, country, description, website, blog, language)

id, create_date, activate_date, last_login_date, username, email, gender, name, firstname, lastname, birth_date, address, zip_code, city, country, description, website, blog, languge

Demo

URL Find your token on - Token

Optional parameters:

return_fields

Add optional parametersRun request

Example:

curl -X GET -H "X-ACCESS-TOKEN: YOUR_ACCESS_TOKEN" "https://api.yumpu.com/2.0/user.json"

Example:

require_once('../yumpu.php');
$yumpu = new Yumpu();
$data = array(
    'return_fields' => 'id,create_date,activate_date,last_login_date,username,email,gender,name,firstname,lastname,birth_date,address,zip_code,city,country,description,website,blog,languge'
);
$getUser = $yumpu->getUser($data);
print_r($getUser);

Example:

var yumpu = require('yumpu');
yumpu.setToken('yourToken');
var parameters = {
   return_fields: 'id,create_date,activate_date,last_login_date,username,email,gender,name,firstname,lastname,birth_date,address,zip_code,city,country,description,website,blog,languge'
};
yumpu.getUser(parameters, function(statusCode, document){
   console.log('Status: ' + statusCode);
   console.log(document);
});

Example:

Yumpu y = new Yumpu("your access token");
String[] params = {"return_fields=id,create_date,activate_date,last_login_date,username,email,gender,name,firstname,lastname,birth_date,address,zip_code,city,country,description,website,blog,languge"};
System.out.println(y.getUser(params));

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

{
  "user": {
    "id": "102864144",
    "create_date": "2013-03-08 17:13:43",
    "activate_date": "2013-04-25 14:20:04",
    "username": "Api.User",
    "email": "yumpu.api@gmail.com",
    "gender": "male",
    "name": "Api User",
    "firstname": "Api",
    "lastname": "User",
    "birth_date": "1986-01-01",
    "address": "Moosackerstr. 17",
    "zip_code": "9444",
    "city": "Diepoldsau",
    "country": "CH",
    "description": "I am the API user.",
    "website": "https://www.yumpu.com",
    "blog": "https://blog.yumpu.com",
    "language": "de"
  },
  "state": "success"
}
yumpu.com