getSubscriptions

GET

/api/v1/subscriptions

const url = 'https://example.com/api/v1/subscriptions?include_unsubscribed=false&limit=50';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/v1/subscriptions?include_unsubscribed=false&limit=50' \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Query Parameters

include_unsubscribed

boolean

Whether to include unsubscribed feeds in the response

since

string

The cursor position to start at

limit

number format: int64

default: 50

The number of results to include per page

Responses

200

Subscriptions found

application/json

object

results

required

Array

object

sync_id

required

The server-generated synchronization ID for the subscription

string format: uuid

guid

required

The guid field as found in the podcast’s RSS feed

string

feed_url

required

The canonical address of the podcast RSS feed

string format: url

subscribed_at

required

The UTC timestamp at which the user subscribed to the feed

string format: date-time

unsubscribed_at

The UTC timestamp at which the user unsubscribed from the feed

string format: date-time

has_next

required

Whether there is a next page of results

boolean

next_cursor

The URL of the next page of results, if available

string format: url

prev_cursor

The URL of the previous page of results, if available

string format: url

Example

{
  "results": [
    {
      "sync_id": "4648b4d7-90bf-497c-a5e7-8383d1083d76",
      "guid": "677ea490-690e-51cb-8b43-755df6c55270",
      "feed_url": "https://example.com/feed1",
      "subscribed_at": "2026-07-11T15:30:00.1Z"
    },
    {
      "sync_id": "aa840671-fc3b-430b-b8f2-92e6e9c7832b",
      "guid": "a388867e-ce91-54d3-a116-114b07bb84e9",
      "feed_url": "https://example.com/feed2",
      "subscribed_at": "2026-03-15T12:06:04.1Z",
      "unsubscribed_at": "2026-07-12T12:10:00.1Z"
    }
  ],
  "has_next": true,
  "next_cursor": "/api/v1/subscriptions?since=3"
}

401

Access token is invalid

application/json

Generic error object

object

error

required

The error message

string

description

required

The error description

string

Example

{
  "error": "Unauthorized",
  "description": "The supplied access token is invalid"
}

500

Internal server error

application/json

Generic error object

object

error

required

The error message

string

description

required

The error description

string

Example

{
  "error": "Internal server error",
  "description": "The server encountered an error while processing the request"
}