Objects

The shapes the API answers with. Every field listed is always there, though some can be null. New fields may be added, so ignore ones you don’t know.

Source

Where links come from: the web app, the extension, an import, an integration, an AI assistant connected over MCP, or one of your API keys. Each has its own defaults, and every link remembers the source that saved it.

  • idstring (uuid)
  • namestring
  • kindstring
    One of web, extension, api, import, bookmarklet, clip, share, integration, mcp

User

  • idstring (uuid)
  • usernamestring
  • emailstring (email)
  • email_verifiedboolean
  • display_namestring or null
  • biostring or null
  • websitestring or null
  • avatar_urlstring or null
    The uploaded avatar; null when there isn’t one, as a path on this site.
  • avatar_fitstring or null
    One of fill, fit
  • default_privateboolean
    Whether new links are private unless you say otherwise.
  • digest_frequencystring
    One of off, daily, weekly
  • archive_modestring
    One of off, readable, full
  • appearancestring
    One of system, light, dark
  • planstring
    One of free, pro
  • created_atstring (date-time)

Bookmark

  • idstring (uuid)
  • urlstring
  • titlestring
    Your title if you set one, else the page’s, else the URL.
  • descriptionstring or null
  • notestring or null
  • site_namestring or null
  • iconstring or null
    The site’s icon, as a path on this site.
  • imagestring or null
  • typestring
    What kind of thing it is. Always link for now.
  • privateboolean
  • comments_disabledboolean
  • metadatastring
    Whether the title, description and icon have been fetched yet.
    One of pending, ok, failed
  • link_statusstring
    One of unknown, ok, dead
  • dead_sincestring (date-time) or null
  • snapshotobject or null
    The saved copy of the page, if there is one.
    • idstring (uuid)
    • statusstring
      One of pending, ok, failed
    • modestring
      One of readable, full
    • created_atstring (date-time)
  • sourceSource or null
    What saved this link.
  • tagsarray of object
    • idstring (uuid)
    • namestring
  • collectionsarray of object
    • idstring (uuid)
    • slugstring
    • titlestring
    • privateboolean
  • created_atstring (date-time)
  • updated_atstring (date-time)

Collection

  • idstring (uuid)
  • slugstring
  • titlestring
  • descriptionstring or null
  • privateboolean
  • default_privateboolean or null
    Visibility for links saved into it; null uses the source’s default.
  • archive_modestring or null
    Copy kept of links saved into it; null uses the source’s.
    One of off, readable, full
  • bookmarks_countinteger
  • followers_countinteger
  • created_atstring (date-time)
  • updated_atstring (date-time)

BulkSummary

  • countinteger
    How many links the selection holds.
  • private_countinteger
  • copy_countinteger
    How many have a saved copy (or one on the way).
  • collectionsarray of object
    Collections any of them are in, and how many.
    • idstring (uuid)
    • countinteger
  • tagsarray of object
    Tags any of them have, and how many.
    • idstring (uuid)
    • countinteger

BulkResult

  • affectedinteger
    How many links changed.
  • bookmarksarray of Bookmark
    The links as they are now, when they were picked by id (empty after a delete).

AppliedDefaults

  • visibility_changedinteger
    Links whose visibility changed to the collection’s.
  • copies_queuedinteger
    Links getting a fuller copy of their page.

Tag

  • idstring (uuid)
  • namestring
  • countinteger
    How many of your links have it.

Follower

  • usernamestring
  • display_namestring or null
  • avatar_urlstring or null
    Their avatar, as a path on this site.
  • followed_atstring (date-time)