Presentations API Overview
ClearSlide APIs
What is the ClearSlide Presentation API?
The Presentations API gives you access to a set of secure ClearSlide content and associated metadata for use in your own app. This is a REST API and is organized around the content resources available around ClearSlide web interface.
Prerequisites
When you complete Prerequisites in ClearSlide APIs section, you will have an Authorization Token to test against our API.
How to generate complete Presentations API request code?
You can generate a complete functional request code snippet for the tech stack of your choice.
You can interactively add Headers and Query parameters (including filters and sorting) into the form. The documentation tool updates API request code accordingly.
Developers can copy and paste the auto-generated API request code into your project.
How do I test the Presentations API request code?
Here are a few options:
- Try it out allows you to trigger a request and view JSON results immediately
- Copy the request code snippet into your project. Trigger the request and parse the response to view the results in a JSON format
Sample Request Code
Our reference documentation auto-generates request code in few tech stacks such as Curl, Node, Ruby, Javascript, Python.
curl --request GET \
--url 'https://platform.clearslide.com/v2/presentations?page%5Bsize%5D=1&page%5Bnumber%5D=1&sort%5Bpresentations%5D%5BdateCreated%5D=asc&sort%5Bpresentations%5D%5BdateModified%5D=asc&sort%5Bpresentations%5D%5Bname%5D=asc&filter%5Bpresentations%5D%5Bname%5D=asm&filter%5Bpresentations%5D%5BdateCreated%5D=2017-02-28T14%3A12%3A29%2B02%3A00%2C2017-03-28T14%3A12%3A29%2B02%3A00&filter%5Bpresentations%5D%5BdateModified%5D=2017-02-28T14%3A12%3A29%2B02%3A00%2C2017-03-28T14%3A12%3A29%2B02%3A00&filter%5Bpresentations%5D%5Bbookmarked%5D=true&filter%5Bpresentations%5D%5Bgroups%5D=g1&filter%5Bpresentations%5D%5Btags%5D=tag1' \
--header 'authorization: Bearer a61766c5-3e55-42f8-ae97-9239105f5391' \
--header 'targetuserid: E36J6TFX7HF2GPJNSDT8'
Sample JSON Response
{
"included": [],
"meta": {
"totalPages": 1,
"totalCount": 1
},
"data": [
{
"relationships": {},
"attributes": {
"emailPitchCount": 0,
"bookmarked": false,
"archived": false,
"offlineViewableCount": 43,
"group": "1Group",
"name": "Pitch Deck",
"livePitchCount": 0,
"userId": "E36J6TFX7HF2GPJNSDT8",
"userEmail": "[email protected]",
"dateCreated": "2017-07-14T07:08:51Z",
"viewableCount": 43,
"copiesNumber": 2,
"downloadsNumber": 4,
"previewUrls":[
"https://d2.cloudfront.net/photo/by_id?code=WSSHQBBF4683VRZBYR86",
"https://d2.cloudfront.net/photo/by_id?code=W6E6V4S5RYX763K6T5P2",
"https://d2.cloudfront.net/photo/by_id?code=YHMKHV5SH8V45TKTS6SD",
"https://d2.cloudfront.net/photo/by_id?code=J7VWFBNNYSQFLHUDYVLS",
"https://d2.cloudfront.net/photo/by_id?code=96GQBWP2NFLQQBM4AXSG"
],
"thumbnailUrls": [
"https://d2.cloudfront.net/photo/thumb?code=WSSHQBBF4683VRZBYR86",
"https://d2.cloudfront.net/photo/thumb?code=W6E6V4S5RYX763K6T5P2",
"https://d2.cloudfront.net/photo/thumb?code=YHMKHV5SH8V45TKTS6SD",
"https://d2.cloudfront.net/photo/thumb?code=J7VWFBNNYSQFLHUDYVLS",
"https://d2.cloudfront.net/photo/thumb?code=96GQBWP2NFLQQBM4AXSG"
],
"dateModified": "2017-07-14T07:08:51Z"
},
"type": "presentations",
"id": "L5339S7JZFCJXT3UFQGK",
"links": {
"self": "/presentations/L5339S7JZFCJXT3UFQGK"
}
}
]
}
Presentation API Request
Refer to reference docs for latest and complete description of the API request parameters.
Some of the parameters required
| Parameter Name | Reference Links |
|---|---|
| Authorization | OAuth2.0 Token |
| targetUserId | Returns all presentations that are accessible by the user specified in this parameter. Ids can be obtained from Users API |
Updated almost 4 years ago