getSubscription

GET

/api/v1/subscriptions/{sync_id}

const url = 'https://example.com/api/v1/subscriptions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
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/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Path Parameters

sync_id

required

string format: uuid

The unique sync ID of the subscription

Responses

200

Subscription found

application/json

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

Example

{
  "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"
}

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"
}

404

Subscription not found

application/json

Generic error object

object

error

required

The error message

string

description

required

The error description

string

Example

{
  "error": "Not found",
  "description": "The requested subscription was not found"
}

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"
}