Skip to content
em sa em sa

List saved searches

GET
/api/search/saved
 
curl --request GET \
  --url 'https://example.com/api/search/saved?limit=20&offset=0' \
  --header 'Authorization: Bearer <token>'

List the authenticated user’s saved searches.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
limit
Limit
integer
default: 20 >= 1 <= 50
offset
Offset
integer
0

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
SavedSearchListResponse

Response model for listing saved searches.

object
searches
required
Searches
Array<object>
SavedSearchResponse

Response model for a saved search.

object
id
required
Id
string
name
required
Name
string
query
required
Query
string
mode
required
Mode
string
filters
required
Filters
object
key
additional properties
any
section_key
Any of:
string
alerts_enabled
required
Alerts Enabled
boolean
alert_channel
required
Alert Channel
string
last_result_count
required
Last Result Count
integer
last_scanned_at
Any of:
string
created_at
required
Created At
string
updated_at
required
Updated At
string
total
required
Total
integer
Example generated
{
  "searches": [
    {
      "id": "example",
      "name": "example",
      "query": "example",
      "mode": "example",
      "filters": {},
      "section_key": "example",
      "alerts_enabled": true,
      "alert_channel": "example",
      "last_result_count": 1,
      "last_scanned_at": "example",
      "created_at": "example",
      "updated_at": "example"
    }
  ],
  "total": 1
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}