Sources

List sources

Returns a paginated list of your sources (books, articles, tweets, etc.) along with the number of highlights in each.

get/sources

Request

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

Query parameters

pageinteger

Page number

per_pageinteger

Number of sources per page (max 100)

type'book' | 'article' | 'tweet' | 'podcast' | 'video' | 'self' | 'custom' | 'youtube' | 'author' | 'topics'

Filter by source type

searchstring

Search sources by name or author

updated_sincestring date-time

Only return sources updated after this timestamp (ISO 8601)

include_deletedboolean

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

include_emptyboolean

Include articles that have no highlights yet. Off by default, since existing sync clients treat "source" as "something with highlights". Turn it on to reach an article that was tagged or annotated but never highlighted — its tags and note are otherwise unreachable.

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 sources

Changes

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