SlideShare APIDevelopers HomeDocumentationApply for an API KeyDeveloper ForumHome

• Slideshow

  • List Methods
  • Expand Methods

  • GETget_slideshow/get_slideshow
    Returns slideshow object
    
    

    Parameter	Value	Type	Description
    slideshow_id		string	Id of the slideshow being queried for. One of Id or URL is required
    slideshow_url		string	Url of the slideshow being queried for. One of Id or URL is requried
    username		string	user account username
    password		string	user account password
    exclude_tags	1	boolean	Set it to true if you want exclude tags in the detailed response
    detailed	1	boolean	Set it to 1 if you want a detailed response
    get_transcript	1	boolean	Set it to 1 if you want to return with transcript parameter in the response. requires detailed to be set to 1.

  • GETget_slideshows_by_tag/get_slideshows_by_tag
    Returns slideshows that contain the specified tag
    
    

    Parameter	Value	Type	Description
    tag		string	Tag name
    limit		string	Specify the number of slideshows to return
    offset		string	specify offset
    detailed	1	boolean	Set it to 1 if you want a detailed response

  • GETget_slideshows_by_group/get_slideshows_by_group
    Returns slideshows that are a part of the specified group
    
    

    Parameter	Value	Type	Description
    group_name		string	Group name
    limit		string	Specify the number of slideshows to return
    offset		string	specify offset
    detailed	1	boolean	Set it to 1 if you want a detailed response

  • GETget_slideshows_by_user/get_slideshows_by_user
    Returns user slideshows
    
    

    Parameter	Value	Type	Description
    username_for		string	username of owner of slideshows
    username		string	username of requesting user
    password		string	password of requesting user
    limit		string	Specify the number of slideshows to return
    offset		string	specify offset
    detailed	1	boolean	Set it to 1 if you want a detailed response
    get_unconverted	1	boolean	Whether or not to include unconverted slideshows. 1 to include them, 0 (default) otherwise.

  • GETsearch_slideshows/search_slideshows
    Returns slideshows according to the search criteria
    
    

    Parameter	Value	Type	Description
    q		string	Search keyword
    page		string	The page number of the results (works in conjunction with items_per_page), default is 1
    items_per_page		string	Number of results to return per page, default is 12
    lang	**esptfritnldezhjakoro!!	enumerated	Language of slideshows (default is English, 'en') ('**':All,'es':Spanish,'pt':Portuguese,'fr':French,'it':Italian,'nl':Dutch, 'de':German,'zh':Chinese,'ja':Japanese,'ko':Korean,'ro':Romanian, '!!':Other)
    sort	relevancemostviewedmostdownloadedlatest	enumerated	Sort order, default is relevance
    upload_date	anyweekmonthyear	enumerated	The time period you want to restrict your search to. 'week' would restrict to the last week. (default is 'any')
    what	tag	enumerated	What type of search. If not set, text search is used. 'tag' is the other option.
    download	1	boolean	Slideshows that are available to download; Set to '0' to do this, otherwise default is all slideshows.
    fileformat	allpdfpptodpppspot	enumerated	File format to search for. Default is 'all'. ('pdf':PDF,'ppt':PowerPoint,'odp':Open Office,'pps':PowerPoint Slideshow,'pot':PowerPoint template)
    file_type	allpresentationsdocumentswebinarsvideos	enumerated	File type to search for. Default is 'all'. ('presentations', 'documents', 'webinars','videos')
    cc	1	boolean	Set to '1' to retrieve results under the Creative Commons license. Default is '0'
    cc_adapt	1	boolean	Set to '1' for results under Creative Commons that allow adaption, modification. Default is '0'
    cc_commercial	1	boolean	Set to '1' to retrieve results with the commercial Creative Commons license. Default is '0'
    detailed	1	boolean	Set it to 1 if you want a detailed response
    get_transcript	1	boolean	Set it to 1 if you want to return with transcript parameter in the response. requires detailed to be set to 1.

  • GETedit_slideshow/edit_slideshow
    Returns user tags
    
    

    Parameter	Value	Type	Description
    username		string	owner username of the slideshow which is being edited
    password		string	owner password of the slideshow which is being edited
    slideshow_id		string	Id of slideshow which is being edited
    slideshow_title		string	Title of the slideshow
    slideshow_tags		string	Comma separated list of tags
    make_slideshow_private	YN	enumerated	Should be Y if you want to make the slideshow private. If this is not set, following tags will not be considered
    generate_secret_url	YN	enumerated	Generate a secret URL for the slideshow. Requires make_slideshow_private to be Y
    allow_embeds	YN	enumerated	Sets if other websites should be allowed to embed the slideshow. Requires make_slideshow_private to be Y
    share_with_contacts	YN	enumerated	Sets if your contacts on SlideShare can view the slideshow. Requires make_slideshow_private to be Y

  • GETdelete_slideshow/delete_slideshow
    Deletes a slideshow
    
    

    Parameter	Value	Type	Description
    username		string	owner username of the slideshow which is being deleted
    password		string	owner password of the slideshow which is being deleted
    slideshow_id		string	Id of slideshow which is being deleted

  • GETupload_slideshow/upload_slideshow
    Upload a slideshow
    
    

    Parameter	Value	Type	Description
    username		string	username of the requesting user
    password		string	password of the requesting user
    upload_url		string	string containing an url pointing to the power point file: ex: http://domain.tld/directory/my_power_point.ppt
    slideshow_title		string	Title of the slideshow
    slideshow_description		string	slideshow description
    slideshow_tags		string	Comma separated list of tags
    make_src_public	YN	enumerated	Y if you want users to be able to download the ppt file, N otherwise. Default is Y
    make_slideshow_private	YN	enumerated	Should be Y if you want to make the slideshow private. If this is not set, following tags will not be considered
    generate_secret_url	YN	enumerated	Generate a secret URL for the slideshow. Requires make_slideshow_private to be Y
    allow_embeds	YN	enumerated	Sets if other websites should be allowed to embed the slideshow. Requires make_slideshow_private to be Y
    share_with_contacts	YN	enumerated	Sets if your contacts on SlideShare can view the slideshow. Requires make_slideshow_private to be Y

• User

  • List Methods
  • Expand Methods

  • GETget_user_favorites/get_user_favorites
    Returns user favorites
    
    

    Parameter	Value	Type	Description
    username_for		string	username of user whose favorites are being requested

  • GETget_user_contacts/get_user_contacts
    Returns user contacts
    
    

    Parameter	Value	Type	Description
    username_for		string	username of user whose contacts are being requested
    limit		string	Specify the number of contacts to return
    offset		string	specify offset

  • GETget_user_groups/get_user_groups
    Returns user groups
    
    

    Parameter	Value	Type	Description
    username_for		string	username of user whose groups are being requested
    username		string	username of requesting user
    password		string	password of requesting user

  • GETget_user_tags/get_user_contacts
    Returns user tags
    
    

    Parameter	Value	Type	Description
    username		string	username of user whose tags are being requested
    password		string	password of user whose tags are being requested

• Favorite

  • List Methods
  • Expand Methods

  • GETcheck_favorite/check_favorite
    Check user favorites
    
    

    Parameter	Value	Type	Description
    username		string	username of the requesting user
    password		string	password of the requesting user
    slideshow_id		string	Slideshow which is being checked

  • GETadd_favorite/add_favorite
    Favorites slideshow (identified by slideshow_id)
    
    

    Parameter	Value	Type	Description
    username		string	username of the requesting user
    password		string	password of the requesting user
    slideshow_id		string	the slideshow to be favorited

• Leads

  • List Methods
  • Expand Methods

  • GETget_user_campaign_leads/get_user_campaign_leads
    Get user campaign leads
    
    

    Parameter	Value	Type	Description
    username		string	username of the requesting user
    password		string	password of the requesting user
    campaign_id		string	campaign id to select the leads form
    begin		string	only get leads collected after this UTC date: YYYYMMDDHHMM
    end		string	only get leads collected before this UTC date: YYYYMMDDHHMM

  • GETget_user_campaigns/get_user_campaigns
    Get user campaigns
    
    

    Parameter	Value	Type	Description
    username		string	username of the requesting user
    password		string	password of the requesting user

  • GETget_user_leads/get_user_leads
    Get user leads
    
    

    Parameter	Value	Type	Description
    username		string	username of the requesting user
    password		string	password of the requesting user
    begin		string	only get leads collected after this UTC date: YYYYMMDDHHMM
    end		string	only get leads collected before this UTC date: YYYYMMDDHHMM