Bookmarks
Check app.capabilities for feature support and app.access plus host permissions for authorization. Examples use synthetic values; replace paths, IDs, inputs and filters before calling.
Type Definitions
type Mutation {
addBookmarks(urls: [String!]!, groupId: ID!): [Bookmark!]!
createBookmarkGroup(name: String!): BookmarkGroup!
deleteBookmarkGroup(id: ID!): Boolean!
deleteBookmarks(ids: [ID!]!): ActionResult!
importBookmarks(content: String!): ActionResult!
recordBookmarkClick(id: ID!): Boolean!
updateBookmark(id: ID!, input: BookmarkInput!): Bookmark!
updateBookmarkGroup(id: ID!, name: String!, collapsed: Boolean!, sortOrder: Int!): BookmarkGroup!
}
type Query {
bookmark(id: ID!): Bookmark
bookmarkGroups: [BookmarkGroup!]!
bookmarks: [Bookmark!]!
pageMetadata(url: String!): PageMetadata!
}
type Subscription {
bookmarksUpdated: [Bookmark!]!
}
type ActionResult {
affectedCount: Int!
}
type Bookmark {
id: ID!
url: String!
title: String!
faviconPath: String!
groupId: ID!
pinned: Boolean!
clickCount: Int!
sortOrder: Int!
createdAt: Instant!
updatedAt: Instant!
lastClickedAt: Instant
}
type BookmarkGroup {
id: ID!
name: String!
collapsed: Boolean!
sortOrder: Int!
itemCount: Int!
createdAt: Instant!
updatedAt: Instant!
}
input BookmarkInput {
url: String!
title: String!
faviconUrl: String
groupId: ID!
pinned: Boolean!
sortOrder: Int!
}
scalar Instant
type PageMetadata {
title: String
faviconUrl: String
}Operations
addBookmarks
Create bookmarks for the supplied URLs in the specified group.
mutation addBookmarks($urls: [String!]!, $groupId: ID!) {
addBookmarks(urls: $urls, groupId: $groupId) { id url title faviconPath groupId pinned clickCount sortOrder }
}createBookmarkGroup
Create a new bookmark group.
mutation createBookmarkGroup($name: String!) {
createBookmarkGroup(name: $name) { id name collapsed sortOrder itemCount createdAt updatedAt }
}deleteBookmarkGroup
Delete a bookmark group. Bookmarks inside are not deleted, only ungrouped.
mutation deleteBookmarkGroup($id: ID!) {
deleteBookmarkGroup(id: $id)
}deleteBookmarks
Delete one or more bookmarks by ID.
mutation deleteBookmarks($ids: [ID!]!) {
deleteBookmarks(ids: $ids) { affectedCount }
}importBookmarks
Import bookmarks from the supplied document content and report the affected count.
mutation importBookmarks($content: String!) {
importBookmarks(content: $content) { affectedCount }
}recordBookmarkClick
Increment a bookmark's stored visit count.
mutation recordBookmarkClick($id: ID!) {
recordBookmarkClick(id: $id)
}updateBookmark
Update one or more fields of an existing bookmark.
mutation updateBookmark($id: ID!, $input: BookmarkInput!) {
updateBookmark(id: $id, input: $input) { id url title faviconPath groupId pinned clickCount sortOrder }
}updateBookmarkGroup
Update a bookmark group's name, collapsed state, or sort order.
mutation updateBookmarkGroup($id: ID!, $name: String!, $collapsed: Boolean!, $sortOrder: Int!) {
updateBookmarkGroup(id: $id, name: $name, collapsed: $collapsed, sortOrder: $sortOrder) { id name collapsed sortOrder itemCount createdAt updatedAt }
}bookmark
Read one stored bookmark by ID; return null when it is absent.
query bookmark($id: ID!) {
bookmark(id: $id) { id url title faviconPath groupId pinned clickCount sortOrder }
}bookmarkGroups
List all bookmark groups.
query bookmarkGroups {
bookmarkGroups { id name collapsed sortOrder itemCount createdAt updatedAt }
}bookmarks
List all bookmarks.
query bookmarks {
bookmarks { id url title faviconPath groupId pinned clickCount sortOrder }
}pageMetadata
Fetch a web page's title and favicon URL without saving a bookmark.
query pageMetadata($url: String!) {
pageMetadata(url: $url) { title faviconUrl }
}bookmarksUpdated
Receive updated bookmark records.
subscription bookmarksUpdated {
bookmarksUpdated { id url title faviconPath groupId pinned clickCount sortOrder }
}