Skip to content
calternal docs

Create a saved search

POST
/api/v1/search/saved
curl --request POST \
  --url https://example.com/api/v1/search/saved \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "pinned": true, "query": "example" }'

Creates a saved search. It requires a signed-in User with the data scope. It can return 400 if the request is invalid, 401 if the session is missing or expired, 403 if access is denied and 409 if the request conflicts with the current state. Route: /api/v1/search/saved. Inputs: . Do not automatically replay this operation after an uncertain result.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Input to create a saved search.

object
name
required

Display name (1 to 120 characters).

string
pinned

Show the search in the sidebar. Default: false.

boolean
query
required

Raw query with operators (1 to 512 characters, valid search grammar).

string
Examplegenerated
{
  "name": "example",
  "pinned": true,
  "query": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

The new saved search

Media typeapplication/json

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"
}

400

Section titled “400”

Invalid name or query

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"
  }
}

409

Section titled “409”

Too many saved searches, or the folder is blocked

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"
  }
}