Skip to main content
API docs by Redocly

Queso API (1.0.0)

API documentation for Queso services.

Bookmarks

List all bookmarks

Authorizations:
BearerTokenAuth
query Parameters
aggregate
string

Aggregation syntax using bracket notation (e.g. aggregate[count]=id).

filter
string

Filtering syntax using bracket notation (e.g. filter[read][_eq]=false).

limit
integer

Maximum results per page (default 50).

meta
string

Repeatable parameter for extra metadata keys (e.g. meta=total_count&meta=filter_count).

page
integer

Page number to return (default 1).

search
string

Search query applied across supported bookmark fields.

sort
string

Order results by a field name (prefix with '-' for descending).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a bookmark

Authorizations:
BearerTokenAuth
Request Body schema: application/json
required
title
required
string <= 500 characters
link
required
string <uri> <= 2048 characters
author
string <= 255 characters
Default: ""
estimated_time
integer [ -2147483648 .. 2147483647 ]
Default: 0
is_quote
boolean
Default: false
is_til
boolean
Default: false
tags
Array of strings
read
boolean
Default: false
notes
string
Default: ""
snapshot
string
Default: ""
meta_image
string <uri> <= 2048 characters
Default: ""
source_type
string
Default: "manual"
Enum: "manual" "rss" "import"
  • manual - Manual
  • rss - RSS
  • import - Import
source_id
integer or null [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "link": "http://example.com",
  • "author": "",
  • "estimated_time": 0,
  • "is_quote": false,
  • "is_til": false,
  • "tags": [
    ],
  • "read": false,
  • "notes": "",
  • "snapshot": "",
  • "meta_image": "",
  • "source_type": "manual",
  • "source_id": -2147483648
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a bookmark

Authorizations:
BearerTokenAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update a bookmark

Authorizations:
BearerTokenAuth
path Parameters
id
required
integer
Request Body schema: application/json
title
string <= 500 characters
link
string <uri> <= 2048 characters
author
string <= 255 characters
estimated_time
integer [ -2147483648 .. 2147483647 ]
is_quote
boolean
is_til
boolean
tags
Array of strings
read
boolean
notes
string
snapshot
string
meta_image
string <uri> <= 2048 characters
source_type
string
Enum: "manual" "rss" "import"
  • manual - Manual
  • rss - RSS
  • import - Import
source_id
integer or null [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "link": "http://example.com",
  • "author": "string",
  • "estimated_time": -2147483648,
  • "is_quote": true,
  • "is_til": true,
  • "tags": [
    ],
  • "read": true,
  • "notes": "string",
  • "snapshot": "string",
  • "meta_image": "http://example.com",
  • "source_type": "manual",
  • "source_id": -2147483648
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a bookmark

Authorizations:
BearerTokenAuth
path Parameters
id
required
integer

Responses

RSS

List all RSS feeds

Authorizations:
BearerTokenAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Subscribe to RSS feed

Authorizations:
BearerTokenAuth
Request Body schema: application/json
required
url
required
string <uri> <= 2000 characters

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get RSS feed subscription

Authorizations:
BearerTokenAuth
path Parameters
rssFeedId
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Toggle RSS feed visibility

Authorizations:
BearerTokenAuth
path Parameters
rssFeedId
required
integer
Request Body schema: application/json
required
active
required
boolean

Responses

Request samples

Content type
application/json
{
  • "active": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Unsubscribe from RSS feed

Authorizations:
BearerTokenAuth
path Parameters
rssFeedId
required
integer

Responses

Get RSS feed entries

Authorizations:
BearerTokenAuth
path Parameters
rssFeedId
required
integer
query Parameters
limit
integer

Maximum results per page (default 50).

page
integer

Page number to return (default 1).

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get RSS entry details

Authorizations:
BearerTokenAuth
path Parameters
rssItemId
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get recent RSS entries

Authorizations:
BearerTokenAuth
query Parameters
limit
integer

Maximum results per page (default 50).

page
integer

Page number to return (default 1).

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}