HomeUsing the Platform APIPlatform API Reference

collections.getList

This method retrieves a list of collections for a given user.

Parameters

NameTypeDescription
scopestring(optional)This specifies the privacy type of the collections that are returned. This value can either be "public" or "private. If not included, all document collections are returned.
api_keystring(required)API key assigned to your account.
api_sigstring(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_keystring(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_idstring(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.

Sample return XML

<?xml version="1.0" encoding="UTF-8"?><rsp stat="ok"><resultset list="true"><result><collection_id>61</collection_id><collection_name>My Collection</collection_name><description><![CDATA[Long description of my collection.]]></description><doc_count>5</doc_count></result><result><collection_id>62</collection_id><collection_name>My Other Collection</collection_name><description><![CDATA[Long description of my other collection.]]></description><doc_count>1</doc_count></result></resultset></rsp>

Result explanation

NameTypeDescription
resultlistContains each individual result.
collection_idintegerThe unique id of the collection. This can be used for other collection-related API calls.
collection_namestringThe name of the collection.
descriptionstringThe collection description.
doc_countintegerThe total number of documents in the collection.

Error codes

401Unauthorized
500Internal Server Error. Scribd has been notified about this problem.
601Required parameter missing

Back to Platform API Reference

scribd