GET https://api.usecommune.com/articles/{article}/highlights Production. There is no separate sandbox host.

List an article's highlights

The passages readers marked in this article, in the order they appear in the body. Use start_offset and end_offset to place them, and quote with prefix and suffix to re anchor when the body has since changed.

Highlights are not attributed to a named person. Each carries an owner_key, an opaque value that is stable per highlighter within one article and meaningless across articles, so a client can count distinct highlighters and group one person's marks without learning who they are.

Path parameters

  • string Required

Query parameters

  • string
  • integer
  • string
  • string

Request Headers

  • string
GET /articles/{article}/highlights
Loading...

Share your request

Use this link to easily share a pre-filled request of this operation. Everything you filled will be shared apart from the authentication fields.

Request URL

https://api-reference.usecommune.dev/explorer/operation/operation-listarticlehighlights

Send a delete request

It looks like you’re about to send a DELETE request to this API. This type of request carries a risk of permanent and irreversible data loss.

Are you sure you want to continue?
Response
Waiting for a request to be sent.