Simplecast's API makes it possible for you to customize your podcasting experience. What do you want to build? Manage your shows, episodes, and discover more with analytics using our powerful platform.
This document gives you the tools you need to start building. Our API is self-describing. Each response gives your app all the information it needs to perform related actions.
Resources
Following are descriptions of commonly used resources in the API.
Account
The billed entity. Contains the related billing address and information.
Subscription
Defines recurring charges and features.
User
Authenticated actor with controlled permissions.
Podcast
A collection of digital audio files which a user can download in order to listen to.
Invitation
Grants podcast or account management access to users based on their email.
Podcast Permission
Control users' access to podcasts.
Author
The podcast creator and guest(s).
Season
A grouping of related episodes.
Episode
An audio file with associated syndication information.
Get Started
URL
The API can be accessed at, https://apidocs.simplecast.com.
Authentication
-
Get your api token from your Private Apps page.
-
Then, with each request, include your api token as your bearer token in the authentication header, e.g.:
authorization: Bearer {token}
Paging
To page responses on list endpoints, you can use query parameters "limit" and "offset".
https://api.simplecast.com/podcasts/{podcast_id}/episodes?limit=12&offset=0Limit denotes the maximum number of objects to return, while offset specifies where to start the page.
Versioning
At this point, there is one version for 2.0, which the following endpoints hit. We will add a versioning option to the header soon. But, rest assured, we won't make any breaking changes in the meantime.
Note: if you have migrated from legacy Simplecast to the new Simplecast, your access to the 1.0 API will continue to function, but after migration any new data (both episodes and analytics) will only be accessible through the 2.0 API.
Endpoints
Each endpoint returns actions options in the form of JSON based on the access of the user or client. Each action option is described with a URL, inputs, and HTTP method.
Here are a few endpoints you may want to start with. Hit these endpoints with the authentication described above to see related actions.
Podcasts
GET /podcasts
Get a list of podcasts the user or client has access to.
curl https://api.simplecast.com/podcasts -H 'authorization: Bearer {token}'
GET /podcasts/{podcast_id}
Get a specific podcast.
curl https://api.simplecast.com/podcasts/{podcast_id} -H 'authorization: Bearer {token}'
POST /podcasts/{podcast_id}
Update podcast settings.
curl -X POST https://api.simplecast.com/podcasts/{podcast_id} -H 'authorization: Bearer {token}' -H 'content-type: application/json' -d '{"copyright":"My new copyright"}'
Episodes
GET /podcasts/{podcast_id}/episodes
Get a list of episodes for a podcast.
curl https://api.simplecast.com/podcasts/{podcast_id}/episodes -H 'authorization: Bearer {token}'
GET /episodes/{episode_id}
Get an episode.
curl https://api.simplecast.com/episodes/{episode_id} -H 'authorization: Bearer {token}'
Analytics
GET /analytics?podcast={podcast_id}
Get links to analytics for a podcast.
curl https://api.simplecast.com/analytics?podcast={podcast_id} -H 'authorization: Bearer {token}'
GET /analytics?episode={episode_id}
Get links to analytics for an episode.
curl https://api.simplecast.com/analytics?episode={episode_id} -H 'authorization: Bearer {token}'
Try it out!
The following api token has read-only access to a demo show.
eyJhcGlfa2V5IjoiYWIwMDI3NDMzZDUyMzNmYWFhMTcwZjI4ZDBjNjY2ODIifQ==
Start with the /podcasts endpoint as described above to get a podcast_id and see responses.
curl https://api.simplecast.com/podcasts -H 'authorization: Bearer eyJhcGlfa2V5IjoiYWIwMDI3NDMzZDUyMzNmYWFhMTcwZjI4ZDBjNjY2ODIifQ=='For more examples, check out your network tab as you navigate your show's site and dashboard.
• • •
Still have questions? We'd be happy to answer them. You can reach our Support Team at support@simplecast.com!