docs.getList
This method retrieves a list of documents for a given user.
Parameters
| Name | Type | Description |
|---|
| api_key | string | (required)
API key assigned to your account.
|
| api_sig | string | (optional)
MD5 hash of the active request and your secret key. This is an optional security measure. See the signing documentation for more info.
|
| session_key | string | (optional)
A session key for a signed in user. If this parameter is provided, your application will carry out actions on behalf of the signed in user corresponding to the session key. Otherwise, your application will carry out actions on behalf of the user account associated with the API account. See the authentication documentation for more information
|
| my_user_id | string | (optional)
This parameter is intended for sites with their own user authentication system. You can create phantom Scribd accounts that correspond to your users by simply passing the unique identifier you use to identify your own user accounts to my_user_id. If you pass this parameter to an API method, the API will act as if it were executed by the phantom user corresponding to my_user_id. See the authentication documentation for more information.
|
| use_api_account | boolean | (optional)
If true, will show all documents associated with this API account, instead of the Scribd user account. This will include documents created through my_user_id users
|
| limit | integer | (optional)
The number of documents to return. You can paginate through the full list using the limit and offset parameters. The maximum limit is 1000.
|
| offset | integer | (optional)
The offset into the list of documents. You can paginate through the full list using the limit and offset parameters.
|
Sample return XML
<?xml version="1.0" encoding="UTF-8"?>
<rsp stat="ok">
<resultset totalResultsAvailable="2" totalResultsReturned="2" firstResultPosition="1" list="true">
<result>
<doc_id>244565</doc_id>
<isbn>1234567890123</isbn>
<title><![CDATA[Ruby on Java]]></title>
<description><![CDATA[Ruby On Java, Barcamp, Washington DC]]></description>
<access_key>key-t3q5qujoj525yun8gf7</access_key>
<conversion_status>DONE</conversion_status>
<page_count>10</page_count>
<reads>1337</reads>
<when_uploaded>2012-10-11T09:03:49+00:00</when_uploaded>
<when_updated>2013-09-11T09:03:49+00:00</when_updated>
</result>
<result>
<doc_id>244567</doc_id>
<title><![CDATA[Ruby on Java Part II]]></title>
<description><![CDATA[Ruby On Java Part II, Barcamp, Washington DC]]></description>
<access_key>key-2b3udhalycthsm91d1ps</access_key>
<conversion_status>DONE</conversion_status>
<page_count>12</page_count>
<reads>0</reads>
</result>
</resultset>
</rsp>
Result explanation
| Name | Type | Description |
|---|
| result | list |
Contains each individual result.
|
| doc_id | integer |
Every document on Scribd has a unique document ID. You can use this ID to link to the document, among other things.
|
| isbn | string |
The ISBN, if available.
|
| secret_password | string |
The secret password allows access to the Scribd pages for private documents. This parameter will only be provided if the given document is actually private.
|
| access_key | string |
The access_key allows you to embed a document on an external site.
|
| title | string |
|
| description | string |
The document description.
|
| thumbnail_url | URL |
Link to a JPG that contains a thumbnail of the document. Do not cache thumbnail URLs - they are subject to change.
|
| conversion_status | ["DISPLAYABLE", "DONE", "ERROR", "PROCESSING"] |
|
| page_count | integer |
The number of pages in the document
|
| reads | integer |
Number of reads
|
| when_uploaded | datetime |
The date the document was originally uploaded
|
| when_updated | datetime |
The date the document was last updated
|
Error codes
| 401 | Unauthorized |
| 500 | Internal Server Error. Scribd has been notified about this problem. |
Back to Platform API Reference
