{"openapi":"3.0.3","info":{"title":"bkmark.it API","version":"1.0.0"},"components":{"securitySchemes":{"session":{"type":"apiKey","in":"cookie","name":"bk_session","description":"Signed-in browser session (the web app). Holds every scope; the only way into account and security routes."},"oauth2":{"type":"oauth2","description":"Authorization code grant; PKCE (S256) required for public clients. Ask for offline_access to get a refresh token.","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","refreshUrl":"/oauth/token","scopes":{"bookmarks:read":"See your bookmarks and their saved copies","bookmarks:write":"Save, edit and delete bookmarks","collections:read":"See your collections","collections:write":"Create, change and delete collections","tags:read":"See your tags","tags:write":"Create, change and delete tags","highlights:read":"See your highlights and notes","highlights:write":"Add, change and delete highlights and notes","offline_access":"Stay connected until you disconnect it"}}}},"apiKey":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Personal API key (`bk_live_…`), also accepted as `Authorization: Bearer bk_live_…`. Needs the same scope as an OAuth2 token."}},"schemas":{}},"paths":{"/health":{"get":{"summary":"Liveness and dependency check","tags":["meta"],"security":[],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]}},"required":["status"],"additionalProperties":false}}}}}}},"/v1/auth/register":{"post":{"summary":"Create an account","tags":["auth"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"password":{"type":"string","minLength":8,"maxLength":256},"name":{"type":"string","maxLength":100}},"required":["email","password"]}}}},"security":[],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/auth/verify-email":{"post":{"summary":"Confirm an email address and sign in","tags":["auth"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":1,"maxLength":200}},"required":["token"]}}}},"security":[],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","enum":["authenticated"]}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","enum":["two_factor_required"]},"methods":{"type":"array","items":{"type":"string","enum":["totp","backup_code","passkey"]}}},"required":["status","methods"],"additionalProperties":false}]}}}}}}},"/v1/auth/resend-verification":{"post":{"summary":"Send a new confirmation link","tags":["auth"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"}},"required":["email"]}}}},"security":[],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/auth/login":{"post":{"summary":"Sign in with email and password","tags":["auth"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"password":{"type":"string","minLength":1,"maxLength":256}},"required":["email","password"]}}}},"security":[],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","enum":["authenticated"]}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","enum":["two_factor_required"]},"methods":{"type":"array","items":{"type":"string","enum":["totp","backup_code","passkey"]}}},"required":["status","methods"],"additionalProperties":false}]}}}}}}},"/v1/auth/login/totp":{"post":{"summary":"Finish signing in with an authenticator code","tags":["auth"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","pattern":"^\\d{6}$"}},"required":["code"]}}}},"security":[],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","enum":["authenticated"]}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","enum":["two_factor_required"]},"methods":{"type":"array","items":{"type":"string","enum":["totp","backup_code","passkey"]}}},"required":["status","methods"],"additionalProperties":false}]}}}}}}},"/v1/auth/login/backup-code":{"post":{"summary":"Finish signing in with a backup code","tags":["auth"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":6,"maxLength":32}},"required":["code"]}}}},"security":[],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","enum":["authenticated"]}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","enum":["two_factor_required"]},"methods":{"type":"array","items":{"type":"string","enum":["totp","backup_code","passkey"]}}},"required":["status","methods"],"additionalProperties":false}]}}}}}}},"/v1/auth/logout":{"post":{"summary":"Sign out this browser","tags":["auth"],"security":[],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/auth/reauth":{"post":{"summary":"Confirm your identity before a sensitive action","tags":["auth"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"password":{"type":"string","minLength":1,"maxLength":256}},"required":["password"]},{"type":"object","properties":{"passkey":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":1024},"rawId":{"type":"string","minLength":1,"maxLength":1024},"type":{"type":"string","enum":["public-key"]},"response":{"type":"object","additionalProperties":{}},"clientExtensionResults":{"default":{},"type":"object","additionalProperties":{}},"authenticatorAttachment":{"type":"string"}},"required":["id","rawId","type","response"],"additionalProperties":{}}},"required":["passkey"]}]}}}},"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/auth/password/forgot":{"post":{"summary":"Email a password reset link","tags":["auth"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"}},"required":["email"]}}}},"security":[],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/auth/password/reset":{"post":{"summary":"Set a new password with a reset link","tags":["auth"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":1,"maxLength":200},"password":{"type":"string","minLength":8,"maxLength":256}},"required":["token","password"]}}}},"security":[],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/auth/password/change":{"post":{"summary":"Change (or set) your password; signs out other sessions","tags":["auth"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"currentPassword":{"type":"string","minLength":1,"maxLength":256},"newPassword":{"type":"string","minLength":8,"maxLength":256}},"required":["newPassword"]}}}},"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/auth/sessions":{"get":{"summary":"List signed-in sessions","tags":["auth"],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"current":{"type":"boolean"},"createdAt":{"type":"string"},"lastActiveAt":{"type":"string"},"ip":{"type":"string"},"userAgent":{"type":"string"},"method":{"type":"string"}},"required":["id","current","createdAt","lastActiveAt","ip","userAgent","method"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}}}},"delete":{"summary":"Sign out every other session","tags":["auth"],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/auth/sessions/{id}":{"delete":{"summary":"Sign out one session","tags":["auth"],"parameters":[{"schema":{"type":"string","pattern":"^[0-9a-f]{64}$"},"in":"path","name":"id","required":true}],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/auth/totp/setup":{"post":{"summary":"Start authenticator setup (needs a recent sign-in or re-auth)","tags":["auth"],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"secret":{"type":"string"},"otpauthUrl":{"type":"string"}},"required":["secret","otpauthUrl"],"additionalProperties":false}}}}}}},"/v1/auth/totp/enable":{"post":{"summary":"Confirm authenticator setup; returns backup codes once (needs a recent sign-in or re-auth)","tags":["auth"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","pattern":"^\\d{6}$"}},"required":["code"]}}}},"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"backupCodes":{"type":"array","items":{"type":"string"}}},"required":["backupCodes"],"additionalProperties":false}}}}}}},"/v1/auth/totp/disable":{"post":{"summary":"Turn off two-factor authentication","tags":["auth"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","pattern":"^\\d{6}$"}},"required":["code"]}}}},"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/auth/totp/backup-codes":{"post":{"summary":"Replace backup codes","tags":["auth"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","pattern":"^\\d{6}$"}},"required":["code"]}}}},"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"backupCodes":{"type":"array","items":{"type":"string"}}},"required":["backupCodes"],"additionalProperties":false}}}}}}},"/v1/auth/passkeys/register/options":{"post":{"summary":"Start adding a passkey (needs a recent sign-in or re-auth)","tags":["auth"],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"challenge":{"type":"string"}},"required":["challenge"],"additionalProperties":{}}}}}}}},"/v1/auth/passkeys/register":{"post":{"summary":"Finish adding a passkey (needs a recent sign-in or re-auth)","tags":["auth"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":1024},"rawId":{"type":"string","minLength":1,"maxLength":1024},"type":{"type":"string","enum":["public-key"]},"response":{"type":"object","additionalProperties":{}},"clientExtensionResults":{"default":{},"type":"object","additionalProperties":{}},"authenticatorAttachment":{"type":"string"}},"required":["id","rawId","type","response"],"additionalProperties":{}},"name":{"type":"string","minLength":1,"maxLength":64}},"required":["response"]}}}},"security":[{"session":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/auth/passkeys":{"get":{"summary":"List your passkeys","tags":["auth"],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"createdAt":{"type":"string"},"lastUsedAt":{"nullable":true,"type":"string"},"backedUp":{"type":"boolean"}},"required":["id","name","createdAt","lastUsedAt","backedUp"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}}}}},"/v1/auth/passkeys/{id}":{"delete":{"summary":"Remove a passkey","tags":["auth"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/auth/passkeys/authenticate/options":{"post":{"summary":"Start a passkey sign-in, second factor or re-auth","tags":["auth"],"security":[],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"challenge":{"type":"string"}},"required":["challenge"],"additionalProperties":{}}}}}}}},"/v1/auth/passkeys/login":{"post":{"summary":"Sign in with a passkey (also completes a pending second-factor step)","tags":["auth"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":1024},"rawId":{"type":"string","minLength":1,"maxLength":1024},"type":{"type":"string","enum":["public-key"]},"response":{"type":"object","additionalProperties":{}},"clientExtensionResults":{"default":{},"type":"object","additionalProperties":{}},"authenticatorAttachment":{"type":"string"}},"required":["id","rawId","type","response"],"additionalProperties":{}}},"required":["response"]}}}},"security":[],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","enum":["authenticated"]}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","enum":["two_factor_required"]},"methods":{"type":"array","items":{"type":"string","enum":["totp","backup_code","passkey"]}}},"required":["status","methods"],"additionalProperties":false}]}}}}}}},"/v1/auth/providers":{"get":{"summary":"Which social sign-in options are available","tags":["auth"],"security":[],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"google":{"type":"boolean"},"github":{"type":"boolean"}},"required":["google","github"],"additionalProperties":false}}}}}}},"/v1/auth/oauth/{provider}/start":{"get":{"summary":"Redirect to Google or GitHub to sign in","tags":["auth"],"parameters":[{"schema":{"type":"string","maxLength":2000},"in":"query","name":"returnTo","required":false},{"schema":{"type":"string","enum":["google","github"]},"in":"path","name":"provider","required":true}],"security":[],"responses":{"200":{"description":"Default Response"}}}},"/v1/auth/oauth/{provider}/callback":{"get":{"summary":"Provider redirect target; signs in and redirects to the web app","tags":["auth"],"parameters":[{"schema":{"type":"string","maxLength":2000},"in":"query","name":"code","required":false},{"schema":{"type":"string","maxLength":200},"in":"query","name":"state","required":false},{"schema":{"type":"string","maxLength":200},"in":"query","name":"error","required":false},{"schema":{"type":"string","enum":["google","github"]},"in":"path","name":"provider","required":true}],"security":[],"responses":{"200":{"description":"Default Response"}}}},"/oauth/authorize":{"get":{"summary":"Start an authorization: validates the request, then sends the browser to the consent page","tags":["oauth"],"description":"Authorization code grant. `code_challenge` (S256) is required for public clients. Errors after the client and redirect URI check out are sent back to `redirect_uri` with `error` and `state`.","parameters":[{"schema":{"type":"string"},"in":"query","name":"response_type","required":false},{"schema":{"type":"string","minLength":1,"maxLength":200},"in":"query","name":"client_id","required":true},{"schema":{"type":"string","minLength":1,"maxLength":2048},"in":"query","name":"redirect_uri","required":true},{"schema":{"default":"","type":"string","maxLength":1000},"in":"query","name":"scope","required":false},{"schema":{"type":"string","maxLength":1000},"in":"query","name":"state","required":false},{"schema":{"type":"string","maxLength":200},"in":"query","name":"code_challenge","required":false},{"schema":{"type":"string","maxLength":20},"in":"query","name":"code_challenge_method","required":false}],"security":[],"responses":{"200":{"description":"Default Response"}}}},"/oauth/token":{"post":{"summary":"Exchange an authorization code or refresh token for tokens","tags":["oauth"],"description":"Form-encoded or JSON. Client authentication: HTTP Basic or `client_id`/`client_secret` in the body; public clients send `client_id` and `code_verifier`. Refresh tokens rotate; presenting a used one revokes the grant.","security":[],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"access_token":{"type":"string"},"token_type":{"type":"string","enum":["Bearer"]},"expires_in":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"scope":{"type":"string"},"refresh_token":{"type":"string"}},"required":["access_token","token_type","expires_in","scope"],"additionalProperties":false}}}}}}},"/oauth/revoke":{"post":{"summary":"Revoke an access or refresh token (RFC 7009; always 200)","tags":["oauth"],"description":"Revoking a refresh token revokes the whole grant (every token issued from the same authorization).","security":[],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}}},"/oauth/token-info":{"get":{"summary":"The calling OAuth2 token or API key: its user, scopes, library and expiry","tags":["oauth"],"security":[],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"active":{"type":"boolean","enum":[true]},"via":{"type":"string","enum":["oauth","api_key"]},"clientId":{"nullable":true,"type":"string"},"scopes":{"type":"array","items":{"type":"string"}},"libraryId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expiresAt":{"nullable":true,"type":"string"},"user":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"email":{"type":"string"},"name":{"type":"string"}},"required":["id","email","name"],"additionalProperties":false}},"required":["active","via","clientId","scopes","libraryId","expiresAt","user"],"additionalProperties":false}}}}}}},"/v1/oauth/consent":{"get":{"summary":"What an app is asking for, to render the consent screen (session only)","tags":["oauth"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"response_type","required":false},{"schema":{"type":"string","minLength":1,"maxLength":200},"in":"query","name":"client_id","required":true},{"schema":{"type":"string","minLength":1,"maxLength":2048},"in":"query","name":"redirect_uri","required":true},{"schema":{"default":"","type":"string","maxLength":1000},"in":"query","name":"scope","required":false},{"schema":{"type":"string","maxLength":1000},"in":"query","name":"state","required":false},{"schema":{"type":"string","maxLength":200},"in":"query","name":"code_challenge","required":false},{"schema":{"type":"string","maxLength":20},"in":"query","name":"code_challenge_method","required":false}],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"client":{"type":"object","properties":{"clientId":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["confidential","public"]}},"required":["clientId","name","type"],"additionalProperties":false},"scopes":{"type":"array","items":{"type":"object","properties":{"scope":{"type":"string","enum":["bookmarks:read","bookmarks:write","collections:read","collections:write","tags:read","tags:write","highlights:read","highlights:write","offline_access"]},"description":{"type":"string"}},"required":["scope","description"],"additionalProperties":false}},"redirectUri":{"type":"string"},"libraries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"kind":{"type":"string","enum":["personal","team"]}},"required":["id","name","kind"],"additionalProperties":false}}},"required":["client","scopes","redirectUri","libraries"],"additionalProperties":false}}}}}},"post":{"summary":"Approve or deny an app; returns where to send the browser (session only)","tags":["oauth"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"response_type":{"type":"string"},"client_id":{"type":"string","minLength":1,"maxLength":200},"redirect_uri":{"type":"string","minLength":1,"maxLength":2048},"scope":{"default":"","type":"string","maxLength":1000},"state":{"type":"string","maxLength":1000},"code_challenge":{"type":"string","maxLength":200},"code_challenge_method":{"type":"string","maxLength":20},"approve":{"type":"boolean"},"libraryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["client_id","redirect_uri","approve"]}}}},"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"redirectTo":{"type":"string"}},"required":["redirectTo"],"additionalProperties":false}}}}}}},"/v1/oauth/grants":{"get":{"summary":"Apps you authorized that can still use your account, one per authorization (session only)","tags":["oauth"],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"client":{"type":"object","properties":{"clientId":{"type":"string"},"name":{"type":"string"}},"required":["clientId","name"],"additionalProperties":false},"scopes":{"type":"array","items":{"type":"string"}},"libraryId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"authorizedAt":{"type":"string"}},"required":["id","client","scopes","libraryId","authorizedAt"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}}}}},"/v1/oauth/grants/{id}":{"delete":{"summary":"Disconnect an app: revokes every token from that authorization (session only)","tags":["oauth"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/me":{"get":{"summary":"Your account","tags":["account"],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"email":{"type":"string"},"name":{"type":"string"},"emailVerified":{"type":"boolean"},"hasPassword":{"type":"boolean"},"onboardingCompletedAt":{"nullable":true,"type":"string"},"preferences":{"type":"object","additionalProperties":{}},"personalLibraryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"aiProcessing":{"type":"boolean"},"twoFactor":{"type":"object","properties":{"totp":{"type":"boolean"},"passkeys":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"backupCodesRemaining":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["totp","passkeys","backupCodesRemaining"],"additionalProperties":false},"socialAccounts":{"type":"array","items":{"type":"string","enum":["google","github"]}},"createdAt":{"type":"string"}},"required":["id","email","name","emailVerified","hasPassword","onboardingCompletedAt","preferences","personalLibraryId","aiProcessing","twoFactor","socialAccounts","createdAt"],"additionalProperties":false}}}}}},"patch":{"summary":"Update your name, preferences, AI processing or onboarding state","tags":["account"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":100},"preferences":{"type":"object","additionalProperties":{}},"onboardingCompleted":{"type":"boolean","enum":[true]},"aiProcessing":{"type":"boolean"}}}}}},"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"email":{"type":"string"},"name":{"type":"string"},"emailVerified":{"type":"boolean"},"hasPassword":{"type":"boolean"},"onboardingCompletedAt":{"nullable":true,"type":"string"},"preferences":{"type":"object","additionalProperties":{}},"personalLibraryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"aiProcessing":{"type":"boolean"},"twoFactor":{"type":"object","properties":{"totp":{"type":"boolean"},"passkeys":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"backupCodesRemaining":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["totp","passkeys","backupCodesRemaining"],"additionalProperties":false},"socialAccounts":{"type":"array","items":{"type":"string","enum":["google","github"]}},"createdAt":{"type":"string"}},"required":["id","email","name","emailVerified","hasPassword","onboardingCompletedAt","preferences","personalLibraryId","aiProcessing","twoFactor","socialAccounts","createdAt"],"additionalProperties":false}}}}}},"delete":{"summary":"Delete your account, personal library and memberships (needs a sign-in or re-auth in the last 10 minutes)","tags":["account"],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/me/email":{"post":{"summary":"Change your email: a link goes to the new address and a notice to the current one (needs a recent sign-in or re-auth)","tags":["account"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"}},"required":["email"]}}}},"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/me/email/confirm":{"post":{"summary":"Confirm a change of email with the emailed link","tags":["account"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":1,"maxLength":200}},"required":["token"]}}}},"security":[],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/me/security-events":{"get":{"summary":"Your sign-in and security history, newest first","tags":["account"],"parameters":[{"schema":{"type":"string","maxLength":200},"in":"query","name":"cursor","required":false},{"schema":{"default":25,"type":"integer","minimum":1,"maximum":100},"in":"query","name":"limit","required":false}],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"type":{"type":"string"},"ip":{"nullable":true,"type":"string"},"userAgent":{"nullable":true,"type":"string"},"metadata":{"type":"object","additionalProperties":{}},"createdAt":{"type":"string"}},"required":["id","type","ip","userAgent","metadata","createdAt"],"additionalProperties":false}},"nextCursor":{"nullable":true,"type":"string"}},"required":["data","nextCursor"],"additionalProperties":false}}}}}}},"/v1/me/export":{"get":{"summary":"Download everything: your profile, security history and your personal library (JSON)","tags":["account"],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response"}}}},"/v1/api-keys":{"post":{"summary":"Create an API key (Pro; on Free, one Shortcut key with captureOnly). The key is returned once. Needs a recent sign-in or re-auth","tags":["api keys"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"scopes":{"minItems":1,"maxItems":8,"type":"array","items":{"type":"string","enum":["bookmarks:read","bookmarks:write","collections:read","collections:write","tags:read","tags:write","highlights:read","highlights:write"]}},"libraryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"captureOnly":{"type":"boolean"}},"required":["name","scopes"]}}}},"security":[{"session":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"prefix":{"type":"string"},"scopes":{"type":"array","items":{"type":"string"}},"libraryId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"captureOnly":{"type":"boolean"},"lastUsedAt":{"nullable":true,"type":"string"},"expiresAt":{"nullable":true,"type":"string"},"createdAt":{"type":"string"},"key":{"type":"string"}},"required":["id","name","prefix","scopes","libraryId","captureOnly","lastUsedAt","expiresAt","createdAt","key"],"additionalProperties":false}}}}}},"get":{"summary":"Your API keys (never the keys themselves)","tags":["api keys"],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"prefix":{"type":"string"},"scopes":{"type":"array","items":{"type":"string"}},"libraryId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"captureOnly":{"type":"boolean"},"lastUsedAt":{"nullable":true,"type":"string"},"expiresAt":{"nullable":true,"type":"string"},"createdAt":{"type":"string"}},"required":["id","name","prefix","scopes","libraryId","captureOnly","lastUsedAt","expiresAt","createdAt"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}}}}},"/v1/api-keys/{id}":{"delete":{"summary":"Revoke an API key (immediately; webhooks it created are deleted)","tags":["api keys"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/me/inbound-address":{"get":{"summary":"Your secret save-by-email address (created on first use)","tags":["email to save"],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"address":{"type":"string"},"libraryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"enabled":{"type":"boolean"},"createdAt":{"type":"string"}},"required":["address","libraryId","enabled","createdAt"],"additionalProperties":false}}}}}}},"/v1/me/inbound-address/rotate":{"post":{"summary":"Retire your address and issue a new one (mail to the old one is dropped)","tags":["email to save"],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"address":{"type":"string"},"libraryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"enabled":{"type":"boolean"},"createdAt":{"type":"string"}},"required":["address","libraryId","enabled","createdAt"],"additionalProperties":false}}}}}}},"/v1/libraries":{"get":{"summary":"Libraries you belong to, with your role","tags":["libraries"],"security":[{"session":[]},{"oauth2":["bookmarks:read"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["personal","team"]},"name":{"type":"string"},"role":{"type":"string","enum":["admin","member","viewer"]},"plan":{"type":"string","enum":["free","pro","team"]},"trialEndsAt":{"nullable":true,"type":"string"}},"required":["id","kind","name","role","plan","trialEndsAt"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}}}},"post":{"summary":"Create a team library (you become its admin; your first one gets a 14-day Team trial)","tags":["teams"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80}},"required":["name"]}}}},"security":[{"session":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["personal","team"]},"name":{"type":"string"},"role":{"type":"string","enum":["admin","member","viewer"]},"plan":{"type":"string","enum":["free","pro","team"]},"effectivePlan":{"type":"string","enum":["free","pro","team"]},"trialEndsAt":{"nullable":true,"type":"string"},"billingStatus":{"nullable":true,"type":"string","enum":["active","trialing","past_due","paused","canceled"]},"joinDomain":{"nullable":true,"type":"string"},"myDomain":{"type":"string"},"aiProcessing":{"type":"boolean"},"seats":{"type":"object","properties":{"used":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"viewers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["used","total","viewers"],"additionalProperties":false},"memberCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"string"}},"required":["id","kind","name","role","plan","effectivePlan","trialEndsAt","billingStatus","joinDomain","myDomain","aiProcessing","seats","memberCount","createdAt"],"additionalProperties":false}}}}}}},"/v1/libraries/{id}":{"get":{"summary":"A library you belong to: your role, plan and seats","tags":["teams"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["personal","team"]},"name":{"type":"string"},"role":{"type":"string","enum":["admin","member","viewer"]},"plan":{"type":"string","enum":["free","pro","team"]},"effectivePlan":{"type":"string","enum":["free","pro","team"]},"trialEndsAt":{"nullable":true,"type":"string"},"billingStatus":{"nullable":true,"type":"string","enum":["active","trialing","past_due","paused","canceled"]},"joinDomain":{"nullable":true,"type":"string"},"myDomain":{"type":"string"},"aiProcessing":{"type":"boolean"},"seats":{"type":"object","properties":{"used":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"viewers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["used","total","viewers"],"additionalProperties":false},"memberCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"string"}},"required":["id","kind","name","role","plan","effectivePlan","trialEndsAt","billingStatus","joinDomain","myDomain","aiProcessing","seats","memberCount","createdAt"],"additionalProperties":false}}}}}},"patch":{"summary":"Rename a team, set its join domain or turn AI processing on or off (admins)","tags":["teams"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"joinDomain":{"nullable":true,"type":"string","maxLength":253,"pattern":"^(?=.{1,253}$)([a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$"},"aiProcessing":{"type":"boolean"}}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["personal","team"]},"name":{"type":"string"},"role":{"type":"string","enum":["admin","member","viewer"]},"plan":{"type":"string","enum":["free","pro","team"]},"effectivePlan":{"type":"string","enum":["free","pro","team"]},"trialEndsAt":{"nullable":true,"type":"string"},"billingStatus":{"nullable":true,"type":"string","enum":["active","trialing","past_due","paused","canceled"]},"joinDomain":{"nullable":true,"type":"string"},"myDomain":{"type":"string"},"aiProcessing":{"type":"boolean"},"seats":{"type":"object","properties":{"used":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"viewers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["used","total","viewers"],"additionalProperties":false},"memberCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"string"}},"required":["id","kind","name","role","plan","effectivePlan","trialEndsAt","billingStatus","joinDomain","myDomain","aiProcessing","seats","memberCount","createdAt"],"additionalProperties":false}}}}}},"delete":{"summary":"Delete a team library and everything in it (admins; type its name to confirm)","tags":["teams"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"confirmName":{"type":"string","maxLength":200}},"required":["confirmName"]}}}},"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/libraries/{id}/members":{"get":{"summary":"Members of a team library and their roles","tags":["teams"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"email":{"type":"string"},"role":{"type":"string","enum":["admin","member","viewer"]},"isOwner":{"type":"boolean"},"joinedAt":{"type":"string"}},"required":["userId","name","email","role","isOwner","joinedAt"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}}}}},"/v1/libraries/{id}/members/{userId}":{"patch":{"summary":"Change a member's role (admins; a team always keeps one admin)","tags":["teams"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","enum":["admin","member","viewer"]}},"required":["role"]}}}},"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true},{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"userId","required":true}],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"email":{"type":"string"},"role":{"type":"string","enum":["admin","member","viewer"]},"isOwner":{"type":"boolean"},"joinedAt":{"type":"string"}},"required":["userId","name","email","role","isOwner","joinedAt"],"additionalProperties":false}}}}}},"delete":{"summary":"Remove someone from a team (admins; what they saved stays)","tags":["teams"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true},{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"userId","required":true}],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/libraries/{id}/leave":{"post":{"summary":"Leave a team (what you saved stays with the team)","tags":["teams"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/libraries/{id}/invites":{"post":{"summary":"Invite someone by email (admins; Team plan or trial)","tags":["teams"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"role":{"default":"member","type":"string","enum":["admin","member","viewer"]}},"required":["email"]}}}},"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"email":{"type":"string"},"role":{"type":"string","enum":["admin","member","viewer"]},"invitedBy":{"nullable":true,"type":"string"},"expiresAt":{"type":"string"},"createdAt":{"type":"string"}},"required":["id","email","role","invitedBy","expiresAt","createdAt"],"additionalProperties":false}}}}}},"get":{"summary":"Pending invitations (admins)","tags":["teams"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"email":{"type":"string"},"role":{"type":"string","enum":["admin","member","viewer"]},"invitedBy":{"nullable":true,"type":"string"},"expiresAt":{"type":"string"},"createdAt":{"type":"string"}},"required":["id","email","role","invitedBy","expiresAt","createdAt"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}}}}},"/v1/libraries/{id}/invites/{inviteId}":{"delete":{"summary":"Withdraw an invitation (admins)","tags":["teams"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true},{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"inviteId","required":true}],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/invites/{token}":{"get":{"summary":"What an invitation link is for (the invite page, before signing in)","tags":["teams"],"parameters":[{"schema":{"type":"string","minLength":20,"maxLength":100},"in":"path","name":"token","required":true}],"security":[],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"libraryName":{"type":"string"},"inviterName":{"nullable":true,"type":"string"},"role":{"type":"string","enum":["admin","member","viewer"]},"email":{"type":"string"},"status":{"type":"string","enum":["pending","expired","accepted"]}},"required":["libraryName","inviterName","role","email","status"],"additionalProperties":false}}}}}}},"/v1/invites/accept":{"post":{"summary":"Accept an invitation (signed in with the invited address)","tags":["teams"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":20,"maxLength":100}},"required":["token"]}}}},"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"libraryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"role":{"type":"string","enum":["admin","member","viewer"]}},"required":["libraryId","name","role"],"additionalProperties":false}}}}}}},"/v1/invites/decline":{"post":{"summary":"Decline an invitation (it is withdrawn)","tags":["teams"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":20,"maxLength":100}},"required":["token"]}}}},"security":[{"session":[]},{}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/me/joinable-libraries":{"get":{"summary":"Teams your verified email domain lets you join","tags":["teams"],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"memberCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["id","name","memberCount"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}}}}},"/v1/libraries/{id}/join":{"post":{"summary":"Join a team your email domain is allowed into (as a member)","tags":["teams"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"libraryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"role":{"type":"string","enum":["admin","member","viewer"]}},"required":["libraryId","name","role"],"additionalProperties":false}}}}}}},"/v1/bookmarks/{id}/share-to-library":{"post":{"summary":"Copy a bookmark from the current library into another one (e.g. a team)","tags":["bookmarks"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"libraryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"includeMyHighlights":{"default":false,"type":"boolean"},"matchCollections":{"default":false,"type":"boolean"}},"required":["libraryId"]}}}},"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["bookmarks:write"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"libraryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"duplicate":{"type":"boolean"},"highlightsCopied":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["id","libraryId","duplicate","highlightsCopied"],"additionalProperties":false}}}}}}},"/v1/libraries/{id}/slack-channels":{"get":{"summary":"Slack channels that save to this team library, and workspaces you can map from (admins)","tags":["slack"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"workspaces":{"type":"array","items":{"type":"object","properties":{"installationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"teamName":{"nullable":true,"type":"string"},"canCapture":{"type":"boolean"}},"required":["installationId","teamName","canCapture"],"additionalProperties":false}},"mappings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"installationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"teamName":{"nullable":true,"type":"string"},"channelId":{"type":"string"},"channelName":{"type":"string"},"collectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"collectionName":{"type":"string"},"postBack":{"type":"boolean"},"createdAt":{"type":"string"}},"required":["id","installationId","teamName","channelId","channelName","collectionId","collectionName","postBack","createdAt"],"additionalProperties":false}}},"required":["workspaces","mappings"],"additionalProperties":false}}}}}},"post":{"summary":"Save links posted in a Slack channel to a collection (admins; Team plan)","tags":["slack"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"installationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"channelId":{"type":"string","pattern":"^[CG][A-Z0-9]{2,30}$"},"collectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"postBack":{"default":false,"type":"boolean"}},"required":["installationId","channelId","collectionId"]}}}},"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"installationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"teamName":{"nullable":true,"type":"string"},"channelId":{"type":"string"},"channelName":{"type":"string"},"collectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"collectionName":{"type":"string"},"postBack":{"type":"boolean"},"createdAt":{"type":"string"}},"required":["id","installationId","teamName","channelId","channelName","collectionId","collectionName","postBack","createdAt"],"additionalProperties":false}}}}}}},"/v1/libraries/{id}/slack-channels/available":{"get":{"summary":"Channels in a workspace you can map (admins)","tags":["slack"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"query","name":"installationId","required":true},{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"isPrivate":{"type":"boolean"},"mapped":{"type":"boolean"}},"required":["id","name","isPrivate","mapped"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}}}}},"/v1/libraries/{id}/slack-channels/{mappingId}":{"delete":{"summary":"Stop saving links from a Slack channel (admins)","tags":["slack"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true},{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"mappingId","required":true}],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/bookmarks":{"post":{"summary":"Save a link or note. A url already in the library returns it (200, duplicate: true) with tags and collections merged in","tags":["bookmarks"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"default":"link","type":"string","enum":["link","note"]},"url":{"type":"string","maxLength":4096},"title":{"type":"string","maxLength":500},"description":{"type":"string","maxLength":100000},"tags":{"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":50}},"collectionIds":{"maxItems":50,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"source":{"default":"api","type":"string","enum":["web","extension","slack","email","zapier","api","import","shortcut","share_target"]},"sourceDetail":{"type":"string","maxLength":200},"text":{"type":"string","maxLength":10000}}}}}},"security":[{"session":[]},{"oauth2":["bookmarks:write"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"libraryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["link","note"]},"url":{"nullable":true,"type":"string"},"canonicalUrl":{"nullable":true,"type":"string"},"title":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"summary":{"nullable":true,"type":"string"},"siteName":{"nullable":true,"type":"string"},"faviconUrl":{"nullable":true,"type":"string"},"imageUrl":{"nullable":true,"type":"string"},"source":{"type":"string","enum":["web","extension","slack","email","zapier","api","import","shortcut","share_target"]},"sourceDetail":{"nullable":true,"type":"string"},"sourceAuthor":{"nullable":true,"type":"string"},"fetchStatus":{"type":"string","enum":["pending","ok","failed","gone"]},"readAt":{"nullable":true,"type":"string"},"archivedAt":{"nullable":true,"type":"string"},"ribbonedAt":{"nullable":true,"type":"string"},"deletedAt":{"nullable":true,"type":"string"},"lastCheckedAt":{"nullable":true,"type":"string"},"createdBy":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"collectionIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"hasSavedCopy":{"type":"boolean"},"duplicate":{"type":"boolean"}},"required":["id","libraryId","kind","url","canonicalUrl","title","description","summary","siteName","faviconUrl","imageUrl","source","sourceDetail","sourceAuthor","fetchStatus","readAt","archivedAt","ribbonedAt","deletedAt","lastCheckedAt","createdBy","createdAt","updatedAt","tags","collectionIds","hasSavedCopy","duplicate"],"additionalProperties":false}}}},"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"libraryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["link","note"]},"url":{"nullable":true,"type":"string"},"canonicalUrl":{"nullable":true,"type":"string"},"title":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"summary":{"nullable":true,"type":"string"},"siteName":{"nullable":true,"type":"string"},"faviconUrl":{"nullable":true,"type":"string"},"imageUrl":{"nullable":true,"type":"string"},"source":{"type":"string","enum":["web","extension","slack","email","zapier","api","import","shortcut","share_target"]},"sourceDetail":{"nullable":true,"type":"string"},"sourceAuthor":{"nullable":true,"type":"string"},"fetchStatus":{"type":"string","enum":["pending","ok","failed","gone"]},"readAt":{"nullable":true,"type":"string"},"archivedAt":{"nullable":true,"type":"string"},"ribbonedAt":{"nullable":true,"type":"string"},"deletedAt":{"nullable":true,"type":"string"},"lastCheckedAt":{"nullable":true,"type":"string"},"createdBy":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"collectionIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"hasSavedCopy":{"type":"boolean"},"duplicate":{"type":"boolean"}},"required":["id","libraryId","kind","url","canonicalUrl","title","description","summary","siteName","faviconUrl","imageUrl","source","sourceDetail","sourceAuthor","fetchStatus","readAt","archivedAt","ribbonedAt","deletedAt","lastCheckedAt","createdBy","createdAt","updatedAt","tags","collectionIds","hasSavedCopy","duplicate"],"additionalProperties":false}}}}}},"get":{"summary":"List bookmarks with filters and a cursor (deleted=true lists the trash)","tags":["bookmarks"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"query","name":"collection","required":false},{"schema":{"type":"string","minLength":1,"maxLength":50},"in":"query","name":"tag","required":false},{"schema":{"type":"string","enum":["link","note"]},"in":"query","name":"kind","required":false},{"schema":{"type":"string","enum":["web","extension","slack","email","zapier","api","import","shortcut","share_target"]},"in":"query","name":"source","required":false},{"schema":{"type":"string","enum":["true","false"]},"in":"query","name":"unread","required":false},{"schema":{"type":"string","enum":["true","false"]},"in":"query","name":"archived","required":false},{"schema":{"type":"string","enum":["true","false"]},"in":"query","name":"ribboned","required":false},{"schema":{"type":"string","enum":["true","false"]},"in":"query","name":"broken","required":false},{"schema":{"type":"string","enum":["true","false"]},"in":"query","name":"deleted","required":false},{"schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"in":"query","name":"savedAfter","required":false},{"schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"in":"query","name":"savedBefore","required":false},{"schema":{"default":"newest","type":"string","enum":["newest","oldest"]},"in":"query","name":"sort","required":false},{"schema":{"type":"string","maxLength":300},"in":"query","name":"cursor","required":false},{"schema":{"default":50,"type":"integer","minimum":1,"maximum":100},"in":"query","name":"limit","required":false}],"security":[{"session":[]},{"oauth2":["bookmarks:read"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"libraryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["link","note"]},"url":{"nullable":true,"type":"string"},"canonicalUrl":{"nullable":true,"type":"string"},"title":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"summary":{"nullable":true,"type":"string"},"siteName":{"nullable":true,"type":"string"},"faviconUrl":{"nullable":true,"type":"string"},"imageUrl":{"nullable":true,"type":"string"},"source":{"type":"string","enum":["web","extension","slack","email","zapier","api","import","shortcut","share_target"]},"sourceDetail":{"nullable":true,"type":"string"},"sourceAuthor":{"nullable":true,"type":"string"},"fetchStatus":{"type":"string","enum":["pending","ok","failed","gone"]},"readAt":{"nullable":true,"type":"string"},"archivedAt":{"nullable":true,"type":"string"},"ribbonedAt":{"nullable":true,"type":"string"},"deletedAt":{"nullable":true,"type":"string"},"lastCheckedAt":{"nullable":true,"type":"string"},"createdBy":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"collectionIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"hasSavedCopy":{"type":"boolean"}},"required":["id","libraryId","kind","url","canonicalUrl","title","description","summary","siteName","faviconUrl","imageUrl","source","sourceDetail","sourceAuthor","fetchStatus","readAt","archivedAt","ribbonedAt","deletedAt","lastCheckedAt","createdBy","createdAt","updatedAt","tags","collectionIds","hasSavedCopy"],"additionalProperties":false}},"nextCursor":{"nullable":true,"type":"string"}},"required":["data","nextCursor"],"additionalProperties":false}}}}}}},"/v1/bookmarks/bulk":{"post":{"summary":"Apply one action to up to 500 bookmarks","tags":["bookmarks"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","enum":["archive","unarchive","read","unread","ribbon","unribbon","delete","restore","purge","tag","untag","add_to_collection","remove_from_collection"]},"ids":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"tags":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":50}},"collectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["action","ids"]}}}},"security":[{"session":[]},{"oauth2":["bookmarks:write"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"updated":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["updated"],"additionalProperties":false}}}}}}},"/v1/bookmarks/{id}":{"get":{"summary":"One bookmark (trashed ones included)","tags":["bookmarks"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["bookmarks:read"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"libraryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["link","note"]},"url":{"nullable":true,"type":"string"},"canonicalUrl":{"nullable":true,"type":"string"},"title":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"summary":{"nullable":true,"type":"string"},"siteName":{"nullable":true,"type":"string"},"faviconUrl":{"nullable":true,"type":"string"},"imageUrl":{"nullable":true,"type":"string"},"source":{"type":"string","enum":["web","extension","slack","email","zapier","api","import","shortcut","share_target"]},"sourceDetail":{"nullable":true,"type":"string"},"sourceAuthor":{"nullable":true,"type":"string"},"fetchStatus":{"type":"string","enum":["pending","ok","failed","gone"]},"readAt":{"nullable":true,"type":"string"},"archivedAt":{"nullable":true,"type":"string"},"ribbonedAt":{"nullable":true,"type":"string"},"deletedAt":{"nullable":true,"type":"string"},"lastCheckedAt":{"nullable":true,"type":"string"},"createdBy":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"collectionIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"hasSavedCopy":{"type":"boolean"}},"required":["id","libraryId","kind","url","canonicalUrl","title","description","summary","siteName","faviconUrl","imageUrl","source","sourceDetail","sourceAuthor","fetchStatus","readAt","archivedAt","ribbonedAt","deletedAt","lastCheckedAt","createdBy","createdAt","updatedAt","tags","collectionIds","hasSavedCopy"],"additionalProperties":false}}}}}},"patch":{"summary":"Edit a bookmark; a changed url is fetched again","tags":["bookmarks"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","maxLength":4096},"title":{"nullable":true,"type":"string","maxLength":500},"description":{"nullable":true,"type":"string","maxLength":100000},"read":{"type":"boolean"},"archived":{"type":"boolean"},"ribboned":{"type":"boolean"},"tags":{"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":50}},"collectionIds":{"maxItems":50,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["bookmarks:write"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"libraryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["link","note"]},"url":{"nullable":true,"type":"string"},"canonicalUrl":{"nullable":true,"type":"string"},"title":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"summary":{"nullable":true,"type":"string"},"siteName":{"nullable":true,"type":"string"},"faviconUrl":{"nullable":true,"type":"string"},"imageUrl":{"nullable":true,"type":"string"},"source":{"type":"string","enum":["web","extension","slack","email","zapier","api","import","shortcut","share_target"]},"sourceDetail":{"nullable":true,"type":"string"},"sourceAuthor":{"nullable":true,"type":"string"},"fetchStatus":{"type":"string","enum":["pending","ok","failed","gone"]},"readAt":{"nullable":true,"type":"string"},"archivedAt":{"nullable":true,"type":"string"},"ribbonedAt":{"nullable":true,"type":"string"},"deletedAt":{"nullable":true,"type":"string"},"lastCheckedAt":{"nullable":true,"type":"string"},"createdBy":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"collectionIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"hasSavedCopy":{"type":"boolean"}},"required":["id","libraryId","kind","url","canonicalUrl","title","description","summary","siteName","faviconUrl","imageUrl","source","sourceDetail","sourceAuthor","fetchStatus","readAt","archivedAt","ribbonedAt","deletedAt","lastCheckedAt","createdBy","createdAt","updatedAt","tags","collectionIds","hasSavedCopy"],"additionalProperties":false}}}}}},"delete":{"summary":"Move to the trash, or delete for good with ?permanent=true","tags":["bookmarks"],"parameters":[{"schema":{"type":"string","enum":["true","false"]},"in":"query","name":"permanent","required":false},{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["bookmarks:write"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/bookmarks/{id}/restore":{"post":{"summary":"Restore from the trash (409 if the page was saved again since)","tags":["bookmarks"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["bookmarks:write"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"libraryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["link","note"]},"url":{"nullable":true,"type":"string"},"canonicalUrl":{"nullable":true,"type":"string"},"title":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"summary":{"nullable":true,"type":"string"},"siteName":{"nullable":true,"type":"string"},"faviconUrl":{"nullable":true,"type":"string"},"imageUrl":{"nullable":true,"type":"string"},"source":{"type":"string","enum":["web","extension","slack","email","zapier","api","import","shortcut","share_target"]},"sourceDetail":{"nullable":true,"type":"string"},"sourceAuthor":{"nullable":true,"type":"string"},"fetchStatus":{"type":"string","enum":["pending","ok","failed","gone"]},"readAt":{"nullable":true,"type":"string"},"archivedAt":{"nullable":true,"type":"string"},"ribbonedAt":{"nullable":true,"type":"string"},"deletedAt":{"nullable":true,"type":"string"},"lastCheckedAt":{"nullable":true,"type":"string"},"createdBy":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"collectionIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"hasSavedCopy":{"type":"boolean"}},"required":["id","libraryId","kind","url","canonicalUrl","title","description","summary","siteName","faviconUrl","imageUrl","source","sourceDetail","sourceAuthor","fetchStatus","readAt","archivedAt","ribbonedAt","deletedAt","lastCheckedAt","createdBy","createdAt","updatedAt","tags","collectionIds","hasSavedCopy"],"additionalProperties":false}}}}}}},"/v1/trash":{"delete":{"summary":"Empty the trash (trashed bookmarks are also purged after 30 days)","tags":["bookmarks"],"security":[{"session":[]},{"oauth2":["bookmarks:write"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"updated":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["updated"],"additionalProperties":false}}}}}}},"/v1/bookmarks/{id}/refetch":{"post":{"summary":"Fetch the page and its saved copy again","tags":["bookmarks"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["bookmarks:write"]},{"apiKey":[]}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/bookmarks/{id}/check":{"post":{"summary":"Check whether the link still works","tags":["bookmarks"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["bookmarks:write"]},{"apiKey":[]}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/bookmarks/{id}/saved-copy":{"get":{"summary":"The readable copy kept when the page was saved","tags":["bookmarks"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["bookmarks:read"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"bookmarkId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"html":{"type":"string"},"text":{"type":"string"},"wordCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"byline":{"nullable":true,"type":"string"},"publishedAt":{"nullable":true,"type":"string"},"fetchedAt":{"type":"string"},"expiresAt":{"nullable":true,"type":"string"}},"required":["bookmarkId","html","text","wordCount","byline","publishedAt","fetchedAt","expiresAt"],"additionalProperties":false}}}}}}},"/v1/bookmarks/{id}/tags":{"post":{"summary":"Add tags (created if new)","tags":["bookmarks"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"names":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":50}}},"required":["names"]}}}},"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["tags:write"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"libraryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["link","note"]},"url":{"nullable":true,"type":"string"},"canonicalUrl":{"nullable":true,"type":"string"},"title":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"summary":{"nullable":true,"type":"string"},"siteName":{"nullable":true,"type":"string"},"faviconUrl":{"nullable":true,"type":"string"},"imageUrl":{"nullable":true,"type":"string"},"source":{"type":"string","enum":["web","extension","slack","email","zapier","api","import","shortcut","share_target"]},"sourceDetail":{"nullable":true,"type":"string"},"sourceAuthor":{"nullable":true,"type":"string"},"fetchStatus":{"type":"string","enum":["pending","ok","failed","gone"]},"readAt":{"nullable":true,"type":"string"},"archivedAt":{"nullable":true,"type":"string"},"ribbonedAt":{"nullable":true,"type":"string"},"deletedAt":{"nullable":true,"type":"string"},"lastCheckedAt":{"nullable":true,"type":"string"},"createdBy":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"collectionIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"hasSavedCopy":{"type":"boolean"}},"required":["id","libraryId","kind","url","canonicalUrl","title","description","summary","siteName","faviconUrl","imageUrl","source","sourceDetail","sourceAuthor","fetchStatus","readAt","archivedAt","ribbonedAt","deletedAt","lastCheckedAt","createdBy","createdAt","updatedAt","tags","collectionIds","hasSavedCopy"],"additionalProperties":false}}}}}}},"/v1/bookmarks/{id}/tags/{tagId}":{"delete":{"summary":"Remove a tag from a bookmark","tags":["bookmarks"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true},{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"tagId","required":true}],"security":[{"session":[]},{"oauth2":["tags:write"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/collections":{"get":{"summary":"Collections in display order","tags":["collections"],"security":[{"session":[]},{"oauth2":["collections:read"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"hue":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"position":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"bookmarkCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","hue","position","bookmarkCount","createdAt","updatedAt"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}}}},"post":{"summary":"Create a collection (added last)","tags":["collections"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"hue":{"nullable":true,"type":"integer","minimum":0,"maximum":359}},"required":["name"]}}}},"security":[{"session":[]},{"oauth2":["collections:write"]},{"apiKey":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"hue":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"position":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"bookmarkCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","hue","position","bookmarkCount","createdAt","updatedAt"],"additionalProperties":false}}}}}}},"/v1/collections/{id}":{"patch":{"summary":"Rename or recolour a collection","tags":["collections"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"hue":{"nullable":true,"type":"integer","minimum":0,"maximum":359}}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["collections:write"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"hue":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"position":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"bookmarkCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","hue","position","bookmarkCount","createdAt","updatedAt"],"additionalProperties":false}}}}}},"delete":{"summary":"Delete a collection (its bookmarks stay in the library)","tags":["collections"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["collections:write"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/collections/reorder":{"post":{"summary":"Set the display order","tags":["collections"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["ids"]}}}},"security":[{"session":[]},{"oauth2":["collections:write"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"hue":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"position":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"bookmarkCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","hue","position","bookmarkCount","createdAt","updatedAt"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}}}}},"/v1/collections/{id}/bookmarks":{"post":{"summary":"Add bookmarks to a collection","tags":["collections"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"bookmarkIds":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["bookmarkIds"]}}}},"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["collections:write"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"updated":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["updated"],"additionalProperties":false}}}}}}},"/v1/collections/{id}/bookmarks/{bookmarkId}":{"delete":{"summary":"Remove a bookmark from a collection","tags":["collections"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true},{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"bookmarkId","required":true}],"security":[{"session":[]},{"oauth2":["collections:write"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/counts":{"get":{"summary":"Bookmark counts for the sidebar views","tags":["bookmarks"],"security":[{"session":[]},{"oauth2":["bookmarks:read"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"inbox":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"library":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reading":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ribboned":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"broken":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"trash":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["inbox","library","reading","ribboned","broken","trash"],"additionalProperties":false}}}}}}},"/v1/tags":{"get":{"summary":"Tags with live bookmark counts","tags":["tags"],"security":[{"session":[]},{"oauth2":["tags:read"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"bookmarkCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"string"}},"required":["id","name","bookmarkCount","createdAt"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}}}},"post":{"summary":"Create a tag","tags":["tags"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":50}},"required":["name"]}}}},"security":[{"session":[]},{"oauth2":["tags:write"]},{"apiKey":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"bookmarkCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"string"}},"required":["id","name","bookmarkCount","createdAt"],"additionalProperties":false}}}}}}},"/v1/tags/{id}":{"patch":{"summary":"Rename a tag (409 if the name is taken: merge instead)","tags":["tags"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":50}},"required":["name"]}}}},"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["tags:write"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"bookmarkCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"string"}},"required":["id","name","bookmarkCount","createdAt"],"additionalProperties":false}}}}}},"delete":{"summary":"Delete a tag (bookmarks keep everything else)","tags":["tags"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["tags:write"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/tags/{id}/merge":{"post":{"summary":"Merge this tag into another and delete it","tags":["tags"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"intoTagId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["intoTagId"]}}}},"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["tags:write"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"bookmarkCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"string"}},"required":["id","name","bookmarkCount","createdAt"],"additionalProperties":false}}}}}}},"/v1/saved-searches":{"get":{"summary":"Saved searches in display order","tags":["saved searches"],"security":[{"session":[]},{"oauth2":["bookmarks:read"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"query":{"type":"string"},"filters":{"type":"object","properties":{"collection":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"tag":{"type":"string","minLength":1,"maxLength":50},"kind":{"type":"string","enum":["link","note"]},"source":{"type":"string","enum":["web","extension","slack","email","zapier","api","import","shortcut","share_target"]},"unread":{"type":"boolean"},"archived":{"type":"boolean"},"ribboned":{"type":"boolean"},"broken":{"type":"boolean"}},"additionalProperties":false},"position":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdBy":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","query","filters","position","createdBy","createdAt","updatedAt"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}}}},"post":{"summary":"Save a search","tags":["saved searches"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"query":{"default":"","type":"string","maxLength":500},"filters":{"default":{},"type":"object","properties":{"collection":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"tag":{"type":"string","minLength":1,"maxLength":50},"kind":{"type":"string","enum":["link","note"]},"source":{"type":"string","enum":["web","extension","slack","email","zapier","api","import","shortcut","share_target"]},"unread":{"type":"boolean"},"archived":{"type":"boolean"},"ribboned":{"type":"boolean"},"broken":{"type":"boolean"}},"additionalProperties":false},"position":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["name"]}}}},"security":[{"session":[]},{"oauth2":["bookmarks:write"]},{"apiKey":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"query":{"type":"string"},"filters":{"type":"object","properties":{"collection":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"tag":{"type":"string","minLength":1,"maxLength":50},"kind":{"type":"string","enum":["link","note"]},"source":{"type":"string","enum":["web","extension","slack","email","zapier","api","import","shortcut","share_target"]},"unread":{"type":"boolean"},"archived":{"type":"boolean"},"ribboned":{"type":"boolean"},"broken":{"type":"boolean"}},"additionalProperties":false},"position":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdBy":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","query","filters","position","createdBy","createdAt","updatedAt"],"additionalProperties":false}}}}}}},"/v1/saved-searches/{id}":{"patch":{"summary":"Edit a saved search","tags":["saved searches"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"query":{"type":"string","maxLength":500},"filters":{"type":"object","properties":{"collection":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"tag":{"type":"string","minLength":1,"maxLength":50},"kind":{"type":"string","enum":["link","note"]},"source":{"type":"string","enum":["web","extension","slack","email","zapier","api","import","shortcut","share_target"]},"unread":{"type":"boolean"},"archived":{"type":"boolean"},"ribboned":{"type":"boolean"},"broken":{"type":"boolean"}},"additionalProperties":false},"position":{"type":"integer","minimum":0,"maximum":9007199254740991}}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["bookmarks:write"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"query":{"type":"string"},"filters":{"type":"object","properties":{"collection":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"tag":{"type":"string","minLength":1,"maxLength":50},"kind":{"type":"string","enum":["link","note"]},"source":{"type":"string","enum":["web","extension","slack","email","zapier","api","import","shortcut","share_target"]},"unread":{"type":"boolean"},"archived":{"type":"boolean"},"ribboned":{"type":"boolean"},"broken":{"type":"boolean"}},"additionalProperties":false},"position":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdBy":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","query","filters","position","createdBy","createdAt","updatedAt"],"additionalProperties":false}}}}}},"delete":{"summary":"Delete a saved search","tags":["saved searches"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["bookmarks:write"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/search":{"get":{"summary":"Hybrid search (full text + meaning) with the matched passage per bookmark. Free plans get keyword search","tags":["search"],"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":500},"in":"query","name":"q","required":true},{"schema":{"default":"current","type":"string","enum":["current","all"]},"in":"query","name":"scope","required":false},{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"query","name":"collection","required":false},{"schema":{"type":"string","minLength":1,"maxLength":50},"in":"query","name":"tag","required":false},{"schema":{"type":"string","enum":["link","note"]},"in":"query","name":"kind","required":false},{"schema":{"type":"string","enum":["web","extension","slack","email","zapier","api","import","shortcut","share_target"]},"in":"query","name":"source","required":false},{"schema":{"type":"string","enum":["true","false"]},"in":"query","name":"unread","required":false},{"schema":{"type":"string","enum":["true","false"]},"in":"query","name":"archived","required":false},{"schema":{"type":"string","enum":["true","false"]},"in":"query","name":"ribboned","required":false},{"schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"in":"query","name":"savedAfter","required":false},{"schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"in":"query","name":"savedBefore","required":false},{"schema":{"default":"ranked","type":"string","enum":["ranked","exact_url"]},"in":"query","name":"match","required":false},{"schema":{"type":"string","maxLength":300},"in":"query","name":"cursor","required":false},{"schema":{"default":20,"type":"integer","minimum":1,"maximum":50},"in":"query","name":"limit","required":false}],"security":[{"session":[]},{"oauth2":["bookmarks:read"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"bookmark":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"libraryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["link","note"]},"url":{"nullable":true,"type":"string"},"canonicalUrl":{"nullable":true,"type":"string"},"title":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"summary":{"nullable":true,"type":"string"},"siteName":{"nullable":true,"type":"string"},"faviconUrl":{"nullable":true,"type":"string"},"imageUrl":{"nullable":true,"type":"string"},"source":{"type":"string","enum":["web","extension","slack","email","zapier","api","import","shortcut","share_target"]},"sourceDetail":{"nullable":true,"type":"string"},"sourceAuthor":{"nullable":true,"type":"string"},"fetchStatus":{"type":"string","enum":["pending","ok","failed","gone"]},"readAt":{"nullable":true,"type":"string"},"archivedAt":{"nullable":true,"type":"string"},"ribbonedAt":{"nullable":true,"type":"string"},"deletedAt":{"nullable":true,"type":"string"},"lastCheckedAt":{"nullable":true,"type":"string"},"createdBy":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"collectionIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"hasSavedCopy":{"type":"boolean"}},"required":["id","libraryId","kind","url","canonicalUrl","title","description","summary","siteName","faviconUrl","imageUrl","source","sourceDetail","sourceAuthor","fetchStatus","readAt","archivedAt","ribbonedAt","deletedAt","lastCheckedAt","createdBy","createdAt","updatedAt","tags","collectionIds","hasSavedCopy"],"additionalProperties":false},"libraryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"score":{"type":"number"},"matchedIn":{"type":"string","enum":["title","url","description","saved_copy","highlight","note","meaning"]},"passage":{"nullable":true,"type":"object","properties":{"text":{"type":"string"},"marks":{"type":"array","items":{"type":"array","items":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}]},"minItems":2,"maxItems":2}}},"required":["text","marks"],"additionalProperties":false}},"required":["bookmark","libraryId","score","matchedIn","passage"],"additionalProperties":false}},"nextCursor":{"nullable":true,"type":"string"},"mode":{"type":"string","enum":["hybrid","keyword"]},"tookMs":{"type":"number"}},"required":["results","nextCursor","mode","tookMs"],"additionalProperties":false}}}}}}},"/v1/saved-searches/{id}/results":{"get":{"summary":"Run a saved search in its library (no query text = its filters, newest first)","tags":["saved searches"],"parameters":[{"schema":{"type":"string","maxLength":300},"in":"query","name":"cursor","required":false},{"schema":{"default":20,"type":"integer","minimum":1,"maximum":50},"in":"query","name":"limit","required":false},{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["bookmarks:read"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"bookmark":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"libraryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["link","note"]},"url":{"nullable":true,"type":"string"},"canonicalUrl":{"nullable":true,"type":"string"},"title":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"summary":{"nullable":true,"type":"string"},"siteName":{"nullable":true,"type":"string"},"faviconUrl":{"nullable":true,"type":"string"},"imageUrl":{"nullable":true,"type":"string"},"source":{"type":"string","enum":["web","extension","slack","email","zapier","api","import","shortcut","share_target"]},"sourceDetail":{"nullable":true,"type":"string"},"sourceAuthor":{"nullable":true,"type":"string"},"fetchStatus":{"type":"string","enum":["pending","ok","failed","gone"]},"readAt":{"nullable":true,"type":"string"},"archivedAt":{"nullable":true,"type":"string"},"ribbonedAt":{"nullable":true,"type":"string"},"deletedAt":{"nullable":true,"type":"string"},"lastCheckedAt":{"nullable":true,"type":"string"},"createdBy":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"collectionIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"hasSavedCopy":{"type":"boolean"}},"required":["id","libraryId","kind","url","canonicalUrl","title","description","summary","siteName","faviconUrl","imageUrl","source","sourceDetail","sourceAuthor","fetchStatus","readAt","archivedAt","ribbonedAt","deletedAt","lastCheckedAt","createdBy","createdAt","updatedAt","tags","collectionIds","hasSavedCopy"],"additionalProperties":false},"libraryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"score":{"type":"number"},"matchedIn":{"type":"string","enum":["title","url","description","saved_copy","highlight","note","meaning"]},"passage":{"nullable":true,"type":"object","properties":{"text":{"type":"string"},"marks":{"type":"array","items":{"type":"array","items":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}]},"minItems":2,"maxItems":2}}},"required":["text","marks"],"additionalProperties":false}},"required":["bookmark","libraryId","score","matchedIn","passage"],"additionalProperties":false}},"nextCursor":{"nullable":true,"type":"string"},"mode":{"type":"string","enum":["hybrid","keyword"]},"tookMs":{"type":"number"}},"required":["results","nextCursor","mode","tookMs"],"additionalProperties":false}}}}}}},"/v1/bookmarks/{id}/highlights":{"get":{"summary":"Your highlights and the library-visible ones, in reading order","tags":["highlights"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["highlights:read"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"bookmarkId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"authorId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"visibility":{"type":"string","enum":["private","library"]},"text":{"type":"string"},"prefix":{"type":"string"},"suffix":{"type":"string"},"startOffset":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"endOffset":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"note":{"nullable":true,"type":"string"},"color":{"type":"string","enum":["yellow","green","blue","pink","purple"]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","bookmarkId","authorId","visibility","text","prefix","suffix","startOffset","endOffset","note","color","createdAt","updatedAt"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}}}},"post":{"summary":"Highlight a passage of the saved copy","tags":["highlights"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"string","minLength":1,"maxLength":5000},"prefix":{"default":"","type":"string","maxLength":64},"suffix":{"default":"","type":"string","maxLength":64},"startOffset":{"type":"integer","minimum":0,"maximum":9007199254740991},"endOffset":{"type":"integer","minimum":1,"maximum":9007199254740991},"note":{"nullable":true,"type":"string","maxLength":10000},"color":{"default":"yellow","type":"string","enum":["yellow","green","blue","pink","purple"]},"visibility":{"default":"private","type":"string","enum":["private","library"]}},"required":["text","startOffset","endOffset"]}}}},"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["highlights:write"]},{"apiKey":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"bookmarkId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"authorId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"visibility":{"type":"string","enum":["private","library"]},"text":{"type":"string"},"prefix":{"type":"string"},"suffix":{"type":"string"},"startOffset":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"endOffset":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"note":{"nullable":true,"type":"string"},"color":{"type":"string","enum":["yellow","green","blue","pink","purple"]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","bookmarkId","authorId","visibility","text","prefix","suffix","startOffset","endOffset","note","color","createdAt","updatedAt"],"additionalProperties":false}}}}}}},"/v1/highlights/{id}":{"patch":{"summary":"Edit your highlight’s note, colour or visibility","tags":["highlights"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"note":{"nullable":true,"type":"string","maxLength":10000},"color":{"type":"string","enum":["yellow","green","blue","pink","purple"]},"visibility":{"type":"string","enum":["private","library"]}}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["highlights:write"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"bookmarkId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"authorId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"visibility":{"type":"string","enum":["private","library"]},"text":{"type":"string"},"prefix":{"type":"string"},"suffix":{"type":"string"},"startOffset":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"endOffset":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"note":{"nullable":true,"type":"string"},"color":{"type":"string","enum":["yellow","green","blue","pink","purple"]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","bookmarkId","authorId","visibility","text","prefix","suffix","startOffset","endOffset","note","color","createdAt","updatedAt"],"additionalProperties":false}}}}}},"delete":{"summary":"Delete your highlight","tags":["highlights"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["highlights:write"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/bookmarks/{id}/notes/me":{"get":{"summary":"Your private note on a bookmark (empty body if none)","tags":["highlights"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["highlights:read"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"bookmarkId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"body":{"type":"string"},"updatedAt":{"nullable":true,"type":"string"}},"required":["bookmarkId","body","updatedAt"],"additionalProperties":false}}}}}},"put":{"summary":"Write your private note (an empty body deletes it)","tags":["highlights"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","maxLength":100000}},"required":["body"]}}}},"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["highlights:write"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"bookmarkId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"body":{"type":"string"},"updatedAt":{"nullable":true,"type":"string"}},"required":["bookmarkId","body","updatedAt"],"additionalProperties":false}}}}}}},"/v1/bookmarks/{id}/notes/shared":{"get":{"summary":"The team’s shared note on a bookmark (team libraries)","tags":["highlights"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["highlights:read"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"bookmarkId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"body":{"type":"string"},"updatedAt":{"nullable":true,"type":"string"}},"required":["bookmarkId","body","updatedAt"],"additionalProperties":false}}}}}},"put":{"summary":"Write the team’s shared note (members and admins; an empty body deletes it)","tags":["highlights"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","maxLength":100000}},"required":["body"]}}}},"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["highlights:write"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"bookmarkId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"body":{"type":"string"},"updatedAt":{"nullable":true,"type":"string"}},"required":["bookmarkId","body","updatedAt"],"additionalProperties":false}}}}}}},"/v1/bookmarks/{id}/suggestions":{"get":{"summary":"AI tag and collection suggestions, and the summary","tags":["bookmarks"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["bookmarks:read"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":50},"confidence":{"type":"number","minimum":0,"maximum":1}},"required":["name","confidence"],"additionalProperties":false}},"collections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"confidence":{"type":"number","minimum":0,"maximum":1}},"required":["id","name","confidence"],"additionalProperties":false}},"summary":{"nullable":true,"type":"string"},"status":{"type":"string","enum":["pending","ready","unavailable","quota_exceeded"]}},"required":["tags","collections","summary","status"],"additionalProperties":false}}}}}},"post":{"summary":"Accept (apply) or dismiss suggestions; dismissed ones are not suggested again","tags":["bookmarks"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"acceptTags":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":50}},"dismissTags":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":50}},"acceptCollections":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"dismissCollections":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["bookmarks:write"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":50},"confidence":{"type":"number","minimum":0,"maximum":1}},"required":["name","confidence"],"additionalProperties":false}},"collections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"confidence":{"type":"number","minimum":0,"maximum":1}},"required":["id","name","confidence"],"additionalProperties":false}},"summary":{"nullable":true,"type":"string"},"status":{"type":"string","enum":["pending","ready","unavailable","quota_exceeded"]}},"required":["tags","collections","summary","status"],"additionalProperties":false}}}}}}},"/v1/share-links":{"get":{"summary":"Active share links in the library","tags":["sharing"],"security":[{"session":[]},{"oauth2":["bookmarks:read"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"token":{"type":"string"},"url":{"type":"string"},"bookmarkId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"collectionId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"targetName":{"nullable":true,"type":"string"},"expiresAt":{"nullable":true,"type":"string"},"createdAt":{"type":"string"}},"required":["id","token","url","bookmarkId","collectionId","targetName","expiresAt","createdAt"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}}}},"post":{"summary":"Create a public read-only link to a bookmark or collection","tags":["sharing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"bookmarkId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"collectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}}}}}},"security":[{"session":[]},{"oauth2":["bookmarks:write"]},{"apiKey":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"token":{"type":"string"},"url":{"type":"string"},"bookmarkId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"collectionId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"targetName":{"nullable":true,"type":"string"},"expiresAt":{"nullable":true,"type":"string"},"createdAt":{"type":"string"}},"required":["id","token","url","bookmarkId","collectionId","targetName","expiresAt","createdAt"],"additionalProperties":false}}}}}}},"/v1/share-links/{id}":{"delete":{"summary":"Revoke a share link","tags":["sharing"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["bookmarks:write"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/public/share/{token}":{"get":{"summary":"What a share link shows (no account needed)","tags":["sharing"],"parameters":[{"schema":{"type":"string","minLength":16,"maxLength":100},"in":"path","name":"token","required":true}],"security":[],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["bookmark"]},"indexable":{"type":"boolean"},"bookmark":{"type":"object","properties":{"kind":{"type":"string","enum":["link","note"]},"url":{"nullable":true,"type":"string"},"title":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"siteName":{"nullable":true,"type":"string"},"faviconUrl":{"nullable":true,"type":"string"},"imageUrl":{"nullable":true,"type":"string"},"savedAt":{"type":"string"}},"required":["kind","url","title","description","siteName","faviconUrl","imageUrl","savedAt"],"additionalProperties":false}},"required":["kind","indexable","bookmark"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","enum":["collection"]},"indexable":{"type":"boolean"},"collection":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":false},"bookmarks":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["link","note"]},"url":{"nullable":true,"type":"string"},"title":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"siteName":{"nullable":true,"type":"string"},"faviconUrl":{"nullable":true,"type":"string"},"imageUrl":{"nullable":true,"type":"string"},"savedAt":{"type":"string"}},"required":["kind","url","title","description","siteName","faviconUrl","imageUrl","savedAt"],"additionalProperties":false}},"truncated":{"type":"boolean"}},"required":["kind","indexable","collection","bookmarks","truncated"],"additionalProperties":false}]}}}}}}},"/v1/import":{"post":{"summary":"Import a bookmarks file. It is stored and parsed by a job (202); progress over SSE and GET /v1/import/:id. dryRun stops at `analyzed` with what would happen. One import at a time (409)","tags":["import and export"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"format":{"type":"string","enum":["netscape","pocket","raindrop","bkmark"]},"data":{"type":"string","minLength":1,"maxLength":10000000},"dryRun":{"default":false,"type":"boolean"}},"required":["format","data"]}}}},"security":[{"session":[]},{"oauth2":["bookmarks:write"]},{"apiKey":[]}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"importId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["queued","running","analyzed","completed","failed"]},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"processed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"imported":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"duplicates":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"invalid":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"analysis":{"nullable":true,"type":"object","properties":{"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"new":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"duplicates":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"invalid":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"newCollections":{"type":"array","items":{"type":"string"}},"tags":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["total","new","duplicates","invalid","newCollections","tags"],"additionalProperties":false},"error":{"nullable":true,"type":"string"}},"required":["importId","status","total","processed","imported","duplicates","invalid","analysis","error"],"additionalProperties":false}}}}}}},"/v1/import/{id}/start":{"post":{"summary":"Import the file of an analyzed dry run","tags":["import and export"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["bookmarks:write"]},{"apiKey":[]}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"importId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["queued","running","analyzed","completed","failed"]},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"processed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"imported":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"duplicates":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"invalid":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"analysis":{"nullable":true,"type":"object","properties":{"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"new":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"duplicates":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"invalid":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"newCollections":{"type":"array","items":{"type":"string"}},"tags":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["total","new","duplicates","invalid","newCollections","tags"],"additionalProperties":false},"error":{"nullable":true,"type":"string"}},"required":["importId","status","total","processed","imported","duplicates","invalid","analysis","error"],"additionalProperties":false}}}}}}},"/v1/import/{id}":{"get":{"summary":"Progress of an import you started","tags":["import and export"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["bookmarks:read"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"importId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["queued","running","analyzed","completed","failed"]},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"processed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"imported":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"duplicates":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"invalid":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"analysis":{"nullable":true,"type":"object","properties":{"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"new":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"duplicates":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"invalid":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"newCollections":{"type":"array","items":{"type":"string"}},"tags":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["total","new","duplicates","invalid","newCollections","tags"],"additionalProperties":false},"error":{"nullable":true,"type":"string"}},"required":["importId","status","total","processed","imported","duplicates","invalid","analysis","error"],"additionalProperties":false}}}}}}},"/v1/export":{"get":{"summary":"Download the library as bkmark JSON (with highlights and notes when the caller has highlights:read), browser HTML or CSV","tags":["import and export"],"parameters":[{"schema":{"default":"json","type":"string","enum":["json","html","csv"]},"in":"query","name":"format","required":false}],"security":[{"session":[]},{"oauth2":["bookmarks:read"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response"}}}},"/v1/events":{"get":{"summary":"Server-sent events for every library you belong to: bookmark.created/updated/deleted, fetch.completed, and your import.progress/completed","tags":["events"],"security":[{"session":[]},{"oauth2":["bookmarks:read"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response"}}}},"/v1/webhooks":{"post":{"summary":"Subscribe a URL to library events (Pro). The signing secret is returned once","tags":["webhooks"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","maxLength":2048},"events":{"minItems":1,"maxItems":7,"type":"array","items":{"type":"string","enum":["bookmark.created","bookmark.updated","bookmark.deleted","bookmark.restored","highlight.created","collection.bookmark_added","tag.created"]}},"collectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":{"type":"string","maxLength":200}},"required":["url","events"]}}}},"security":[{"session":[]},{"oauth2":["bookmarks:read"]},{"apiKey":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"libraryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"url":{"type":"string"},"events":{"type":"array","items":{"type":"string","enum":["bookmark.created","bookmark.updated","bookmark.deleted","bookmark.restored","highlight.created","collection.bookmark_added","tag.created"]}},"collectionId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":{"nullable":true,"type":"string"},"active":{"type":"boolean"},"disabledReason":{"nullable":true,"type":"string"},"consecutiveFailures":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastDeliveryAt":{"nullable":true,"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"secret":{"type":"string"}},"required":["id","libraryId","url","events","collectionId","description","active","disabledReason","consecutiveFailures","lastDeliveryAt","createdAt","updatedAt","secret"],"additionalProperties":false}}}}}},"get":{"summary":"Your webhooks in the library","tags":["webhooks"],"security":[{"session":[]},{"oauth2":["bookmarks:read"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"libraryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"url":{"type":"string"},"events":{"type":"array","items":{"type":"string","enum":["bookmark.created","bookmark.updated","bookmark.deleted","bookmark.restored","highlight.created","collection.bookmark_added","tag.created"]}},"collectionId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":{"nullable":true,"type":"string"},"active":{"type":"boolean"},"disabledReason":{"nullable":true,"type":"string"},"consecutiveFailures":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastDeliveryAt":{"nullable":true,"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","libraryId","url","events","collectionId","description","active","disabledReason","consecutiveFailures","lastDeliveryAt","createdAt","updatedAt"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}}}}},"/v1/webhooks/{id}":{"patch":{"summary":"Change a webhook, or turn it off and on (on clears its failure count)","tags":["webhooks"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","maxLength":2048},"events":{"minItems":1,"maxItems":7,"type":"array","items":{"type":"string","enum":["bookmark.created","bookmark.updated","bookmark.deleted","bookmark.restored","highlight.created","collection.bookmark_added","tag.created"]}},"collectionId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":{"nullable":true,"type":"string","maxLength":200},"active":{"type":"boolean"}}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["bookmarks:read"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"libraryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"url":{"type":"string"},"events":{"type":"array","items":{"type":"string","enum":["bookmark.created","bookmark.updated","bookmark.deleted","bookmark.restored","highlight.created","collection.bookmark_added","tag.created"]}},"collectionId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":{"nullable":true,"type":"string"},"active":{"type":"boolean"},"disabledReason":{"nullable":true,"type":"string"},"consecutiveFailures":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastDeliveryAt":{"nullable":true,"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","libraryId","url","events","collectionId","description","active","disabledReason","consecutiveFailures","lastDeliveryAt","createdAt","updatedAt"],"additionalProperties":false}}}}}},"delete":{"summary":"Delete a webhook (Zapier unsubscribes here)","tags":["webhooks"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["bookmarks:read"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/webhooks/{id}/deliveries":{"get":{"summary":"Recent deliveries, newest first (kept 30 days)","tags":["webhooks"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"query","name":"cursor","required":false},{"schema":{"default":25,"type":"integer","minimum":1,"maximum":100},"in":"query","name":"limit","required":false},{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["bookmarks:read"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"event":{"type":"string"},"status":{"type":"string","enum":["pending","success","failed"]},"attempts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"responseStatus":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"error":{"nullable":true,"type":"string"},"durationMs":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"deliveredAt":{"nullable":true,"type":"string"},"createdAt":{"type":"string"},"payload":{"type":"object","additionalProperties":{}}},"required":["id","event","status","attempts","responseStatus","error","durationMs","deliveredAt","createdAt","payload"],"additionalProperties":false}},"nextCursor":{"nullable":true,"type":"string"}},"required":["data","nextCursor"],"additionalProperties":false}}}}}}},"/v1/webhooks/{id}/test":{"post":{"summary":"Send a signed `ping` now and return the delivery (works while turned off)","tags":["webhooks"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["bookmarks:read"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"event":{"type":"string"},"status":{"type":"string","enum":["pending","success","failed"]},"attempts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"responseStatus":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"error":{"nullable":true,"type":"string"},"durationMs":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"deliveredAt":{"nullable":true,"type":"string"},"createdAt":{"type":"string"},"payload":{"type":"object","additionalProperties":{}}},"required":["id","event","status","attempts","responseStatus","error","durationMs","deliveredAt","createdAt","payload"],"additionalProperties":false}}}}}}},"/v1/slack/install":{"get":{"summary":"Start adding bkmark to a Slack workspace (302 to Slack)","tags":["slack"],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response"}}}},"/v1/slack/oauth/callback":{"get":{"summary":"Slack OAuth redirect: store the installation, connect the installer, back to settings","tags":["slack"],"parameters":[{"schema":{"type":"string","maxLength":500},"in":"query","name":"code","required":false},{"schema":{"type":"string","maxLength":200},"in":"query","name":"state","required":false},{"schema":{"type":"string","maxLength":200},"in":"query","name":"error","required":false}],"security":[{"session":[]},{}],"responses":{"200":{"description":"Default Response"}}}},"/v1/slack/link":{"get":{"summary":"What a \"Connect your bkmark account\" link would connect (does not use it up)","tags":["slack"],"parameters":[{"schema":{"type":"string","minLength":20,"maxLength":100},"in":"query","name":"token","required":true}],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"teamId":{"type":"string"},"teamName":{"nullable":true,"type":"string"},"slackUserId":{"type":"string"},"slackUserName":{"nullable":true,"type":"string"}},"required":["teamId","teamName","slackUserId","slackUserName"],"additionalProperties":false}}}}}},"post":{"summary":"Connect the Slack account from the link to your bkmark account","tags":["slack"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":20,"maxLength":100}},"required":["token"]}}}},"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"redirectTo":{"type":"string"}},"required":["redirectTo"],"additionalProperties":false}}}}}},"delete":{"summary":"Disconnect your Slack account in one workspace","tags":["slack"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"query","name":"installationId","required":true}],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/slack/status":{"get":{"summary":"Slack workspaces you installed bkmark in or are connected in","tags":["slack"],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"available":{"type":"boolean"},"installUrl":{"nullable":true,"type":"string"},"workspaces":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"teamId":{"type":"string"},"teamName":{"nullable":true,"type":"string"},"linked":{"type":"boolean"},"isInstaller":{"type":"boolean"},"canRemove":{"type":"boolean"},"installedAt":{"type":"string"}},"required":["id","teamId","teamName","linked","isInstaller","canRemove","installedAt"],"additionalProperties":false}}},"required":["available","installUrl","workspaces"],"additionalProperties":false}}}}}}},"/v1/slack/installations/{id}":{"delete":{"summary":"Remove bkmark from a Slack workspace (revokes its token; the installer only)","tags":["slack"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/billing":{"get":{"summary":"The library's plan, subscription, payment method and invoices","tags":["billing"],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"libraryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"libraryKind":{"type":"string","enum":["personal","team"]},"plan":{"type":"string","enum":["free","pro","team"]},"effectivePlan":{"type":"string","enum":["free","pro","team"]},"trialEndsAt":{"nullable":true,"type":"string"},"status":{"nullable":true,"type":"string","enum":["active","trialing","past_due","paused","canceled"]},"interval":{"nullable":true,"type":"string","enum":["month","year"]},"seats":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"currentPeriodEnd":{"nullable":true,"type":"string"},"cancelAt":{"nullable":true,"type":"string"},"provider":{"nullable":true,"type":"string","enum":["paddle","fake"]},"manageable":{"type":"boolean"},"paymentMethod":{"nullable":true,"type":"object","properties":{"type":{"type":"string"},"brand":{"nullable":true,"type":"string"},"last4":{"nullable":true,"type":"string"},"expiry":{"nullable":true,"type":"string"}},"required":["type","brand","last4","expiry"],"additionalProperties":false},"invoices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"number":{"nullable":true,"type":"string"},"billedAt":{"nullable":true,"type":"string"},"total":{"type":"string"},"currency":{"type":"string"},"status":{"type":"string"}},"required":["id","number","billedAt","total","currency","status"],"additionalProperties":false}}},"required":["libraryId","libraryKind","plan","effectivePlan","trialEndsAt","status","interval","seats","currentPeriodEnd","cancelAt","provider","manageable","paymentMethod","invoices"],"additionalProperties":false}}}}}}},"/v1/billing/checkout":{"post":{"summary":"Create the checkout transaction (price, seats and library set here) for the Paddle.js overlay","tags":["billing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"plan":{"type":"string","enum":["pro","team"]},"interval":{"default":"month","type":"string","enum":["month","year"]},"seats":{"type":"integer","minimum":2,"maximum":1000}},"required":["plan"]}}}},"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"provider":{"type":"string","enum":["paddle","fake"]},"environment":{"type":"string","enum":["sandbox","production","fake"]},"transactionId":{"type":"string"},"customerEmail":{"type":"string"},"customerId":{"nullable":true,"type":"string"}},"required":["provider","environment","transactionId","customerEmail","customerId"],"additionalProperties":false}}}}}}},"/v1/billing/portal":{"post":{"summary":"A one-off link to Paddle's customer portal","tags":["billing"],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","format":"uri"}},"required":["url"],"additionalProperties":false}}}}}}},"/v1/billing/cancel":{"post":{"summary":"Cancel at the end of the paid period (nothing is deleted)","tags":["billing"],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/billing/resume":{"post":{"summary":"Undo a scheduled cancellation, or resume a paused subscription","tags":["billing"],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/billing/seats":{"patch":{"summary":"Change a team library's seat count (prorated)","tags":["billing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"seats":{"type":"integer","minimum":2,"maximum":1000}},"required":["seats"]}}}},"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/billing/invoices/{id}":{"get":{"summary":"A short-lived link to an invoice PDF","tags":["billing"],"parameters":[{"schema":{"type":"string","pattern":"^txn_\\w+$"},"in":"path","name":"id","required":true}],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","format":"uri"}},"required":["url"],"additionalProperties":false}}}}}}},"/v1/rediscover":{"get":{"summary":"Today's Rediscover picks in the library (chosen on first request of the day)","tags":["rediscover"],"security":[{"session":[]},{"oauth2":["bookmarks:read"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"day":{"type":"string"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"day":{"type":"string"},"position":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reason":{"type":"string","enum":["unread_old","ribboned_unopened","related_recent"]},"reasonText":{"type":"string"},"acted":{"nullable":true,"type":"string","enum":["read","archived","snoozed","dismissed"]},"bookmark":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"libraryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["link","note"]},"url":{"nullable":true,"type":"string"},"canonicalUrl":{"nullable":true,"type":"string"},"title":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"summary":{"nullable":true,"type":"string"},"siteName":{"nullable":true,"type":"string"},"faviconUrl":{"nullable":true,"type":"string"},"imageUrl":{"nullable":true,"type":"string"},"source":{"type":"string","enum":["web","extension","slack","email","zapier","api","import","shortcut","share_target"]},"sourceDetail":{"nullable":true,"type":"string"},"sourceAuthor":{"nullable":true,"type":"string"},"fetchStatus":{"type":"string","enum":["pending","ok","failed","gone"]},"readAt":{"nullable":true,"type":"string"},"archivedAt":{"nullable":true,"type":"string"},"ribbonedAt":{"nullable":true,"type":"string"},"deletedAt":{"nullable":true,"type":"string"},"lastCheckedAt":{"nullable":true,"type":"string"},"createdBy":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"collectionIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"hasSavedCopy":{"type":"boolean"}},"required":["id","libraryId","kind","url","canonicalUrl","title","description","summary","siteName","faviconUrl","imageUrl","source","sourceDetail","sourceAuthor","fetchStatus","readAt","archivedAt","ribbonedAt","deletedAt","lastCheckedAt","createdBy","createdAt","updatedAt","tags","collectionIds","hasSavedCopy"],"additionalProperties":false},"relatedTo":{"nullable":true,"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"nullable":true,"type":"string"},"createdAt":{"type":"string"}},"required":["id","title","createdAt"],"additionalProperties":false}},"required":["id","day","position","reason","reasonText","acted","bookmark","relatedTo"],"additionalProperties":false}},"untouched":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["day","data","untouched"],"additionalProperties":false}}}}}}},"/v1/rediscover/{pickId}/act":{"post":{"summary":"Act on a pick: read, archive, snooze (7 or 30 days) or dismiss (never picked again)","tags":["rediscover"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","enum":["read","archive","snooze","dismiss"]},"days":{"anyOf":[{"type":"number","enum":[7]},{"type":"number","enum":[30]}]}},"required":["action"]}}}},"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"pickId","required":true}],"security":[{"session":[]},{"oauth2":["bookmarks:write"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/bookmarks/{id}/opened":{"post":{"summary":"Record that the bookmark was opened (reader or original); does not mark it read","tags":["bookmarks"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"security":[{"session":[]},{"oauth2":["bookmarks:read"]},{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/v1/me/digest":{"get":{"summary":"Your Rediscover digest email settings","tags":["account"],"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"frequency":{"type":"string","enum":["daily","weekly","off"]},"weekday":{"type":"integer","minimum":0,"maximum":6},"hour":{"type":"integer","minimum":0,"maximum":23},"timezone":{"type":"string"},"available":{"type":"boolean"},"lastSentAt":{"nullable":true,"type":"string"}},"required":["frequency","weekday","hour","timezone","available","lastSentAt"],"additionalProperties":false}}}}}},"put":{"summary":"Change the digest email (turning it on needs Pro: 402 otherwise)","tags":["account"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"frequency":{"type":"string","enum":["daily","weekly","off"]},"weekday":{"type":"integer","minimum":0,"maximum":6},"hour":{"type":"integer","minimum":0,"maximum":23},"timezone":{"type":"string","minLength":1,"maxLength":64}}}}}},"security":[{"session":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"frequency":{"type":"string","enum":["daily","weekly","off"]},"weekday":{"type":"integer","minimum":0,"maximum":6},"hour":{"type":"integer","minimum":0,"maximum":23},"timezone":{"type":"string"},"available":{"type":"boolean"},"lastSentAt":{"nullable":true,"type":"string"}},"required":["frequency","weekday","hour","timezone","available","lastSentAt"],"additionalProperties":false}}}}}}},"/v1/public/rediscover/action":{"get":{"summary":"What a digest link would do (for the confirmation page); never acts","tags":["rediscover"],"parameters":[{"schema":{"type":"string","minLength":16,"maxLength":1024},"in":"query","name":"token","required":true}],"security":[],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","enum":["read","archive","snooze","unsubscribe"]},"bookmark":{"nullable":true,"type":"object","properties":{"title":{"type":"string"},"siteName":{"nullable":true,"type":"string"},"url":{"nullable":true,"type":"string"}},"required":["title","siteName","url"],"additionalProperties":false},"used":{"type":"boolean"}},"required":["action","bookmark","used"],"additionalProperties":false}}}}}},"post":{"summary":"Apply a digest link: its one action, to its one bookmark, once","tags":["rediscover"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":16,"maxLength":1024}},"required":["token"]}}}},"security":[],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"redirectTo":{"nullable":true,"type":"string"}},"required":["message","redirectTo"],"additionalProperties":false}}}}}}},"/v1/public/digest/unsubscribe":{"post":{"summary":"One-click unsubscribe from the digest (RFC 8058)","tags":["rediscover"],"requestBody":{"required":true,"content":{"application/json":{"schema":{}}}},"parameters":[{"schema":{"type":"string","minLength":16,"maxLength":1024},"in":"query","name":"token","required":true}],"security":[],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"redirectTo":{"nullable":true,"type":"string"}},"required":["message","redirectTo"],"additionalProperties":false}}}}}},"get":{"summary":"Opened in a browser: go to the confirmation page","tags":["rediscover"],"parameters":[{"schema":{"type":"string","minLength":16,"maxLength":1024},"in":"query","name":"token","required":true}],"security":[],"responses":{"200":{"description":"Default Response"}}}}}}