Skip to content
calternal docs

List saved searches

GET
/api/v1/search/saved
curl --request GET \
  --url https://example.com/api/v1/search/saved \
  --header 'Authorization: Bearer <token>'

Lists the saved searches. It requires a signed-in User with the data scope. It can return 401 if the session is missing or expired and 403 if access is denied. Route: /api/v1/search/saved. Inputs: . Safe reads can use bounded retries.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The caller’s saved searches

Media typeapplication/json
Array<object>

A saved search: a named query that works like a smart folder (DESIGN §32 S10). It is user data, stored as one JSON file per search in <home>/.calternal/saved-searches/<id>.json.

object
created
required

Creation time (RFC 3339, UTC).

string
id
required

Stable identifier (a lowercase UUID). Links use it, so a rename never breaks them.

string
name
required

Display name chosen by the user.

string
pinned
required

True when the search shows in the sidebar.

boolean
query
required

The raw query, operators included, exactly as the search field shows it.

string
updated
required

Last change time (RFC 3339, UTC).

string
Examplegenerated
[
  {
    "created": "example",
    "id": "example",
    "name": "example",
    "pinned": true,
    "query": "example",
    "updated": "example"
  }
]

401

Section titled “401”

Authentication is required

Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}