Articles

List the articles this account liked

The articles this person liked, most recently liked first.

The same page as GET /saved-articles: the same gates, the same ?expand=article gated the same way, the same silence when an entry is gated away. Read that operation for every rule this one also obeys.

A like is not a save. A save is a private list a person keeps; a like is a signal they gave the newsletter, and the newsletter can read it. Do not treat the two as interchangeable.

This is the reader's half of a like, not the newsletter's. The tally is article.stats.likes, which any credential reads. Who is behind it is readable by the newsletter the like was aimed at, as engagement records on GET /newsletters/{newsletter}/events?event_type=like and as the article.liked topic. This operation is scoped to a person instead: one person's own likes across every newsletter they read.

Needs account: read, which either an API key or an OAuth token can carry.

get/liked-articles

Request

  • Base URL: https://api.usecommune.com
  • URL: https://api.usecommune.com/liked-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

cursorstring

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.

limitinteger

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.

expandstring

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.

fieldsstring

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 liked articles, most recently liked first.

object'list' required

Always list, so a response is self describing.

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.