Issuu Platform & Services

List all documents belonging to a user profile and which satisfies certain criteria.

Authentication

This method requires authentication.

Request parameters

Name	Data type	Description
apiKey	string	Application key for the account
signature	string	See Signing Requests
documentStates	list	Comma-separated list document states indicated by a single char: "A" - Active documents "F" - Documents that failed during conversion "P" - Documents that are currently being processed Leave this field blank to list all documents regardless of state
access	enum	"public" or "private". If no value is submitted both "public" and "private" documents will be returned
origins	list	Comma-separated list of document origins. Valid values are: "apiupload", "apislurp", "singleupload", "multiupload", "singleslurp", "multislurp" and "autoslurp" (i.e. SmartLook) Leave this field blank to list all documents regardless of origin
orgDocTypes	list	Comma-separated list of original document formats: "pdf", "odt", "doc", "wpd", "sxw", "sxi", "rtf", "odp" and "ppt"
orgDocName	string	Original filename of document
resultOrder	enum	"asc" or "desc". Default value is "asc"
startIndex	integer	Zero based index to start pagination from
pageSize	integer	Maximum number of documents to be returned. Value must be between 0 - 30. Default is 10
documentSortBy	enum	Response parameter to sort the result by. Sorting can only be done on a single parameter. Default is no particular sort order
responseParams	list	Comma-separated list of response parameters to be returned. If no value is submitted all parameters will be returned
format	enum	Must be "xml" or "json" - default is "xml". See Getting Started for further details
jsonCallback	string	Function wrapper for JSONP requests. See Getting Started for further details

Example request:

http://api.issuu.com/1_0?action=issuu.documents.list \
    &apiKey=g0ch5rj9ywztlo022w70naymutm2fbbg \
    &startIndex=0 \
    &pageSize=10 \
    &documentStates=A \
    &orgDocTypes=pdf,doc \
    &responseParams=name,documentId,title

Response parameters

Name	Data type	Description
username	string	Owner of document
name	string	Name of document. Combined with username this defines documents location on Issuu: http://issuu.com/<username>/docs/<name>
documentId	string	Unique identifier of the document
title	string	Title of the document
access	enum	"public" or "private"
state	enum	The state of the document
errorCode	string	If document has failed conversion this parameter will give more information about the reason. See Error Codes
category	enum	Category to which the content belongs
type	enum	Physical format of publications
orgDocType	enum	Format of original file
orgDocName	string	The original filename of the uploaded document
origin	enum	The source of the document
language	enum	Language Code for the document
pageCount	integer	The number of pages in the document
publishDate	date	Timestamp for when this document was published
description	string	Description of the content
tags	list	Keywords describing the document
warnings	list	Properties of the original file which could have affected the quality of the finished document. See Warning Codes
folders	list	The folders containing this document

<rsp stat="ok">
  <document username="lekkim" name="racing" documentId="090623122351-f691a27cfd744b80b25a2c8f5a51d596" title="Race cars" access="public" state="P" category="012000" type="009000" origin="singleupload" pageCount="0" ep="1245759831" description="Race cars of Le Man 2009">
    <tags>
      <tag value="cars"/>
      <tag value="le man"/>
      <tag value="racing"/>
    </tags>
    <folders>
      <folder id="3935f331-5d5b-4694-86ce-6f26c6dee809"/>
    </folders>
  </document>
</rsp>

{
    "rsp": {
        "_content": {
            "document": {
                "username": "lekkim",
                "name": "racing",
                "documentId": "090623122351-f691a27cfd744b80b25a2c8f5a51d596",
                "title": "Race cars",
                "access": "public",
                "state": "P",
                "category": "012000",
                "type": "009000",
                "origin": "singleupload",
                "pageCount": 0,
                "ep": 1245759831,
                "description": "Race cars of Le Man 2009",
                "tags": [
                    "cars",
                    "le man",
                    "racing"
                ],
                "folders": [
                    "3935f331-5d5b-4694-86ce-6f26c6dee809"
                ]
            }
        },
        "stat": "ok"
    }
}

Error codes

Code	Message
009	Authentication required
010	Invalid API key
200	Required field is missing
201	Invalid field format