API reference

Use these pages to look up endpoint parameters, response fields and errors. Read the API guide for conventions. Start with the API keys guide for authenticated requests, or the Analytics API guide for interpreting your figures.

Download the OpenAPI specification. Request samples read your identifiers from environment variables. Response examples use illustrative data.

Podcasts (public)

• Get a public podcast

Episodes (public)

• List published episodes
• Get the latest published episode
• Get a published episode by slug or id
• Get a published episode by id

oEmbed

• oEmbed for a show.fm page

Account

• The key and the user it acts for

Your podcasts

• List the podcasts this key can read
• Get one of your podcasts

Analytics

• Downloads for a podcast over time
• Downloads per episode
• Downloads by app, country, device, source or referrer
• Apple and Spotify engagement imports
• Downloads for an episode over time

Episodes

• List episodes of one of your podcasts
• Get an episode
• An episode's roster
• An episode's credits
• An episode's transcript

Connected sites

• Register a site with a WP-CLI key
• Exchange a connect code for a site key
• Report in and go live
• Disconnect your site
• Report the site's health
• Report the WordPress post for an episode
• List the site's changes

Response schemas

• AnalyticsFreshness
• AnalyticsMeta
• AnalyticsMethodology
• AnalyticsRange
• Breakdown
• DisconnectedSite
• DisconnectSiteRequest
• DownloadsPeriod
• Episode
• EpisodeAnalytics
• EpisodeCredit
• EpisodeDownloads
• EpisodeListItem
• EpisodePerson
• Error
• KeyedEpisode
• KeyedEpisodeListItem
• KeyedEpisodeMedia
• KeyedPodcast
• Me
• Oembed
• Pagination
• PlatformMetrics
• Podcast
• PodcastDownloads
• PodcastSummary
• RegisteredSite
• RegisterSiteRequest
• ReportedPost
• ReportPostRequest
• SiteChange
• SiteChangeEpisode
• SiteChanges
• SiteChangesCursor
• SiteExchange
• SiteExchangeRequest
• SiteHealthRecorded
• SiteHealthRequest
• TranscriptPage
• VerifiedSite
• VerifySiteRequest