Skip to content
Open Podcast API

List subscriptions

GET
/v1/subscriptions

Retrieves a paginated list of podcast subscriptions associated with the authenticated user.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
page[number]
integer
default: 1 >= 1

The page of results to return (default: 1).

page[size]
integer
default: 25 >= 1 <= 100

The number of results per page (default: 25, max: 100).

Responses

Section titled “ Responses ”

200

Section titled “200 ”

List of subscriptions successfully returned.

object
jsonapi
object
version
string
Example
1.1
data
Array<object>
object
type
required
string
Allowed values: subscription
Example
subscription
id
required
string format: uuid
Example
ce510f4d-9046-5590-846e-58619ab8b353
attributes
required
object
feedUrl
string format: uri
Example
https://example.com/rss1
userSubscribedAt
string format: date-time
Example
2025-08-24T16:00:00Z
links
required
object
self
string
Example
/v1/subscriptions/ce510f4d-9046-5590-846e-58619ab8b353
unsubscribe
object
href
required
string
Example
/v1/subscriptions/ce510f4d-9046-5590-846e-58619ab8b353
method
required
string
Allowed values: DELETE
Example
DELETE
links
object
self
string
Example
/v1/subscriptions?page[number]=1&page[size]=2
first
string
Example
/v1/subscriptions?page[number]=1&page[size]=2
prev
string
nullable
next
string
nullable
Example
/v1/subscriptions?page[number]=2&page[size]=2
last
string
Example
/v1/subscriptions?page[number]=5&page[size]=2
meta
object
total
integer
Example
10
Example
{
  "jsonapi": {
    "version": "1.1"
  },
  "data": [
    {
      "type": "subscription",
      "id": "ce510f4d-9046-5590-846e-58619ab8b353",
      "attributes": {
        "feedUrl": "https://example.com/rss1",
        "userSubscribedAt": "2025-08-24T16:00:00Z"
      },
      "links": {
        "self": "/v1/subscriptions/ce510f4d-9046-5590-846e-58619ab8b353",
        "unsubscribe": {
          "href": "/v1/subscriptions/ce510f4d-9046-5590-846e-58619ab8b353",
          "method": "DELETE"
        }
      }
    }
  ],
  "links": {
    "self": "/v1/subscriptions?page[number]=1&page[size]=25",
    "first": "/v1/subscriptions?page[number]=1&page[size]=25",
    "prev": null,
    "next": "/v1/subscriptions?page[number]=2&page[size]=25",
    "last": "/v1/subscriptions?page[number]=4&page[size]=25"
  },
  "meta": {
    "total": 100
  }
}