Skip to content

Get a subscription

GET
/v1/subscriptions/{guid}

Fetch a single subscription resource by its globally unique guid, associated with the authenticated user.

guid
required
string format: uuid
Example
ce510f4d-9046-5590-846e-58619ab8b353

The globally unique identifier (UUIDv5) of the subscription resource.

Subscription found and returned successfully.

object
jsonapi
object
version
string
Example
1.1
data
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
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"
}
}
}
}

The provided GUID is not a valid UUID.

object
errors
Array<object>
object
status
required
string
Example
404
title
required
string
Example
Subscription not found
detail
string
Example
The requested subscription does not exist for the user.
Example
{
"errors": [
{
"status": "400",
"title": "Invalid GUID in request",
"detail": "The requested GUID is not a UUID value"
}
]
}

Subscription not found or inaccessible to the user.

object
errors
Array<object>
object
status
required
string
Example
404
title
required
string
Example
Subscription not found
detail
string
Example
The requested subscription does not exist for the user.
Example
{
"errors": [
{
"status": "404",
"title": "Subscription not found",
"detail": "The requested subscription does not exist for the user."
}
]
}