Skip to content
Open Podcast API

Retrieve all episodes for the authenticated user

GET
/episodes

Retrieve all episodes that has changed for the authenticated user since the provided timestamp

Authorizations

Parameters

Query Parameters

since
string format: date-time
Example
2022-04-23T18:25:43.511Z
page
number
Example
1
per_page
number
Example
5

Responses

200

Successful operation

object
total
required
number
page
required
number
per_page
required
number
next
string format: url
previous
string format: url
episodes
required
Array<object>
object
podcast_guid
required
string format: guid
sync_id
required
string format: guid
episode_guid
required
string
title
required
string
publish_date
required
string format: date-time
enclosure_url
required
string format: url
episode_url
required
string format: url
playback_position
played_status
new_status
download_status
favorite_status 
{
  "podcast_guid": "31740ac6-e39d-49cd-9179-634bcecf4143",
  "sync_id": "cff3ea32-4215-4f98-bc23-5358d1f35b55",
  "episode_guid": "https://example.com/podcast/episode-5-the-history-of-RSS",
  "title": "The history of RSS",
  "publish_date": "2022-04-24T17:53:21.573Z",
  "enclosure_url": "https://example.com/podcast/episode-5-the-history-of-RSS.mp3",
  "episode_url": "https://example.com/podcast/episode-5-the-history-of-RSS",
  "playback_position": {
    "value": 0,
    "timestamp": "2024-11-02T13:19"
  },
  "played_status": {
    "value": true,
    "timestamp": "2024-11-02T13:19"
  },
  "new_status": {
    "value": false,
    "timestamp": "2024-10-30T17:31"
  },
  "download_status": {
    "value": false,
    "timestamp": "2024-11-02T13:19"
  },
  "favorite_status": {
    "value": false,
    "timestamp": "2024-11-02T13:19"
  }
}
{
  "total": 2,
  "page": 1,
  "per_page": 5,
  "episodes": [
    {
      "podcast_guid": "31740ac6-e39d-49cd-9179-634bcecf4143",
      "sync_id": "cff3ea32-4215-4f98-bc23-5358d1f35b55",
      "episode_guid": "https://example.com/podcast/episode-5-the-history-of-RSS",
      "title": "The history of RSS",
      "publish_date": "2022-04-24T17:53:21.573Z",
      "enclosure_url": "https://example.com/podcast/episode-5-the-history-of-RSS.mp3",
      "episode_url": "https://example.com/podcast/episode-5-the-history-of-RSS",
      "playback_position": {
        "value": 0,
        "timestamp": "2024-11-02T13:19"
      },
      "played_status": {
        "value": true,
        "timestamp": "2024-11-02T13:19"
      },
      "new_status": {
        "value": false,
        "timestamp": "2024-10-30T17:31"
      },
      "download_status": {
        "value": false,
        "timestamp": "2024-11-02T13:19"
      },
      "favorite_status": {
        "value": false,
        "timestamp": "2024-11-02T13:19"
      }
    },
    {
      "podcast_guid": "9d6786c9-ed48-470d-acbe-e593547f4b5b",
      "sync_id": "5773f457-e71b-417d-8ea8-f07c38a03a3e",
      "episode_guid": "01999e25-08cd-4f29-a61e-6ca459b40d27",
      "title": "Walk with the weatherman",
      "publish_date": "2022-04-27T19:35:20.000Z",
      "enclosure_url": "https://op3.dev/e/https://podcasts.example2.net/audio/@digitalcitizen/49-walk-with-the-weatherman.mp3",
      "episode_url": "https://podcasts.example2.net/@digitalcitizen/episodes/49-walk-with-the-weatherman",
      "playback_position": {
        "value": 2100,
        "timestamp": "2024-11-01T17:38"
      },
      "played_status": {
        "value": false,
        "timestamp": "2024-04-28T09:20"
      },
      "new_status": {
        "value": false,
        "timestamp": "2024-11-01T17:02"
      },
      "download_status": {
        "value": true,
        "timestamp": "2024-11-01T17:02"
      },
      "favorite_status": {
        "value": false,
        "timestamp": "2024-04-28T09:20"
      }
    }
  ]
}

401

Unauthorized

object
code
required
string
message
required
string
Example
{
  "code": 401,
  "message": "User not authorized"
}