List the newsletters this account subscribes to
Every newsletter this account is subscribed to, most recently subscribed first.
Needs account: read, which either an API key or an OAuth token can carry. A row can name a newsletter no other operation will let this credential address, and says nothing about it beyond an identifier.
Only live subscriptions appear. Commune keeps the record when somebody leaves and moves its status instead, so an unsubscribed, bounced or complained record is not returned here.
A subscription Commune learned from a newsletter's email provider is returned beside one made in Commune. What is not returned is the half of that record belonging to the newsletter rather than to the reader: the address the provider held, the provider's own identifier for this person, the tags the newsletter has applied, and how they were acquired.
Read the page as Commune's record of what this person reads rather than a complete one. Commune's subscriber records are a partial cache of each newsletter's provider list, so a newsletter whose provider is not connected to Commune is missing from it, and an unsubscribe made at the provider can take until the next reconciliation to disappear.
newsletter is a reference, and ?expand=newsletter replaces it with a NewsletterSummary, under the rules GET /memberships sets out.
Request
- Base URL: https://api.usecommune.com
- URL: https://api.usecommune.com/subscriptions
- Auth: one of:
- HTTP bearer
- OAuth 2 (authorization code, authorization URL https://usecommune.com/api/oauth/authorize, token URL https://usecommune.com/api/oauth/token, scopes: account:read)
Query parameters
The pagination.next_cursor value from the previous page. Omit it to read the first page. A cursor is opaque, is only valid for the same operation with the same filters, and is not a durable identifier.
How many items to return in this page. This is a page size, not an offset. Fewer items than requested may come back and that does not mean the collection is exhausted, only an absent next_cursor does.
Comma-separated list of relationship paths to inline in the response. Unexpanded relationships are returned as a reference object carrying only id and object. Each operation documents the paths it accepts, and an unknown path answers 400. Nested paths use a dot, for example article.newsletter.
Comma-separated allow-list of top level properties to return on each object, so a client can trim a response it does not need in full. id and object are always returned. An unknown property name answers 400. Properties omitted by an operation, such as content on any article list, cannot be brought back with fields.
Response
A page of subscriptions, most recently subscribed first.
Example response
{
"pagination": {
"next_cursor": "Y3Vyc29yOjE3NTY0MjM2MDAwMDA6MDE5MmM4"
},
"data": [
{
"newsletter": {
"object": "newsletter",
"id": "9a4c1c6e-0f2b-4f47-9d3f-6d1b1a2c3d4e"
}
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.