Get a single subscription
Enables clients to fetch a single subscription resource by its globally unique guid.
GET /v1/subscriptions/{guid}Request format
Section titled “Request format”Clients MUST send a GET request to the canonical URI of a subscription resource, using the guid as the identifier.
Path parameters
Section titled “Path parameters”| Parameter | Type | Description |
|---|---|---|
guid | string | The globally unique identifier (UUIDv5) of the subscription resource. |
Headers
Section titled “Headers”Clients MUST include the following headers:
Accept: application/vnd.api+json
GET /v1/subscriptions/ce510f4d-9046-5590-846e-58619ab8b353 HTTP/1.1Accept: application/vnd.api+jsonServer behavior
Section titled “Server behavior”- The server MUST return a
200 OKresponse with the subscription resource if it exists and is associated with the authenticated user. - If the subscription does not exist, the server MUST return a
404 Not Founderror object. - The server MUST validate that the
guidis a valid UUID format. If it is not, the server MUST return a400 Bad Request.
Success response
Section titled “Success response”If the subscription is found and accessible to the current user:
- HTTP Status:
200 OK - Headers:
Content-Type: application/vnd.api+json
The response body MUST include:
- A top-level
dataobject containing thesubscriptionresource. - A
links.selfpointing to the resource. - A
links.unsubscribepointing to the same resource withmethod: DELETE.
HTTP/1.1 200 OKContent-Type: application/vnd.api+json
{ "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" } } }}Error responses
Section titled “Error responses”| HTTP status | When it occurs |
|---|---|
400 Bad Request | If the provided guid is not a valid UUID. |
404 Not Found | If the subscription does not exist or is inaccessible. |
See error response format for more information.