Highlights

List highlights

Returns a paginated list of your highlights, ordered by most recent first. Includes the source/article each highlight belongs to, and any tags.

get/highlights

Request

  • Base URL: https://api.screvi.com/api/v1
  • URL: https://api.screvi.com/api/v1/highlights
  • Auth: API key in header X-API-Key

Query parameters

pageinteger

Page number

per_pageinteger

Number of highlights per page (max 100)

source_idstring uuid

Filter by source ID

favoriteboolean

Filter by favorite status

tag_idstring uuid

Only highlights carrying this tag. Each highlight still comes back with its full tag list, not just the matched one.

tagstring

Same as tag_id but by tag name, matched case-insensitively against your own tags. Get names from GET /tags.

updated_sincestring date-time

Only return highlights updated after this timestamp (ISO 8601)

include_deletedboolean

Include deleted highlights as tombstones (deleted: true). Required for incremental sync, otherwise deletions are invisible and a local mirror drifts.

include_metadataboolean

Include each item's metadata object, exactly as it was written via POST or PATCH. Off by default to keep responses small.

Response

A paginated list of highlights

Changes

No recorded changes to this operation across all 1 revision of this API.