List the articles this account saved
This account's reading list: the articles this person put aside to come back to, most recently saved first. It is private to them, and no operation in this API reads somebody else's.
A save is never reported to the newsletter that published the article. Reads and likes are, as engagement records and as the article.read and article.liked topics; a save has no topic, no tally on Article.stats, and no engagement event type.
Needs account: read, which either an API key or an OAuth token can carry.
The two rules that gate every article this API serves gate this page too, applied against the person rather than against a newsletter. An article dated in the future is not returned until that moment passes. An article stamped with an audience is returned only while this person is entitled to it: the newsletter's owner, one of its admins or editors, or a subscriber holding one of the article's tags. Leave the segment an article was addressed to and it leaves this page.
So a page can be shorter than the number of saves the person made, and an entry can disappear without the person having removed it. Neither is an error and nothing in the response marks it.
article is a reference, and ?expand=article replaces it with an ArticleSummary: title, preview line, cover and publication date, without the body.
Expanding cannot widen the page. The two rules above are applied again when the article is resolved, so an entry the person may no longer read, or one whose article has been deleted, keeps its bare reference. Treat a reference that stayed a reference as "no detail available", never as an error.
GET /liked-articles is the same page for likes and follows every rule above.
Request
- Base URL: https://api.usecommune.com
- URL: https://api.usecommune.com/saved-articles
- 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 saved articles, most recently saved first.
Example response
{
"pagination": {
"next_cursor": "Y3Vyc29yOjE3NTY0MjM2MDAwMDA6MDE5MmM4"
},
"data": [
{
"article": {
"object": "newsletter",
"id": "9a4c1c6e-0f2b-4f47-9d3f-6d1b1a2c3d4e"
}
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.