list_bookmarks
Products the account saved on the website (read-only).
Ask for it in plain words#
Inputs#
| Name | Type | Required | What it does |
|---|---|---|---|
limit | integer | no | How many bookmarks per page: 1 to 100, default 50. |
cursor | string | no | From the previous result's nextCursor. |
Example#
This account has no bookmarks in the synthetic catalog, so the list is empty. Saving and removing happens on the website.
The example ran over Orvio's synthetic test catalog (a product called Fixture Studio), so its names and values differ from the products you will see. The shape is exactly what the server returns.
Request
{}
Result (shortened)
{ "bookmarks": [], "total": 0, "nextCursor": null }
Left out of the example: release.
What comes back#
| Field | What it holds |
|---|---|
bookmarks | The products you saved on the website, newest first: identifier, name, when you saved it, whether it is still available, and its version. |
total | How many bookmarks you have. |
warnings | Heads-ups that do not stop the call, such as a membership payment problem. Usually empty. |
Every result also carries what the request needs to be checked: the release (product, version, published date), the licence and notes, when they apply.
Paging#
When nextCursor is not null, call again with cursor set to it. A cursor belongs to your account, to that call's inputs and to that release, and it expires after 60 minutes. After a new release it answers release_replaced. See Limits and pagination.
Errors#
| Code | Means | What to do |
|---|---|---|
invalid_input | The arguments do not match the tool's schema, or the cursor is not valid. | Fix the input and call the tool again. |
HTTP 401, 403 or 429 | Before the tool runs: the sign-in is not valid, the membership does not allow access, or there were too many requests. | See Errors and fixes. |
Every tool can also answer service_unavailable and integrity_error: try again in a few minutes.