Skip to content

Saved searches

This page covers:

PUT /api/SavedSearches
GET /api/SavedSearches
DELETE /api/SavedSearches

`PUT /api/SavedSearches`

Save a search definition under the current user.

Item	Value
Method	`PUT`
Path	`/api/SavedSearches`
Auth	User bearer token
Response	Boolean

Query parameters

Parameter	Required	Notes
`name`	Yes	URL-encoded display name
`queryStr`	Yes	URL-encoded query-string fragment to save

queryStr should usually be the search-page fragment without a leading ?, for example:

filterStr=FT%3Dpump%20housing&includeShapelets=true

Example

curl -X PUT "https://your-server.example.com/api/SavedSearches?name=Pump%20Housing%20Search&queryStr=filterStr%3DFT%253Dpump%2520housing%26includeShapelets%3Dtrue" \
  -H "Authorization: Bearer USER_BEARER_TOKEN"

`GET /api/SavedSearches`

List the current user’s saved searches.

Item	Value
Method	`GET`
Path	`/api/SavedSearches`
Auth	User bearer token
Response	Array of saved-search objects

Example response

[
  {
    "ID": "3c0d6b36-3474-45b4-bfe9-c2eddf34d9a0",
    "UserID": "6a5b7d86-1c61-4e0c-9ef9-8d4d1a450f92",
    "SearchVID": "24395dfe-7917-4976-a198-0fe3aa9a6a06",
    "QueryStr": "filterStr=FT%3Dpump%20housing&includeShapelets=true",
    "TimeStamp": "2026-05-10T12:34:56",
    "Name": "Pump Housing Search",
    "Type": 0,
    "URL": "https://your-server.example.com/...&filterStr=FT%3Dpump%20housing&includeShapelets=true"
  }
]

Example

curl "https://your-server.example.com/api/SavedSearches" \
  -H "Authorization: Bearer USER_BEARER_TOKEN"

`DELETE /api/SavedSearches`

Delete one saved search by ID.

Item	Value
Method	`DELETE`
Path	`/api/SavedSearches`
Auth	User bearer token
Response	Boolean

Query parameters

Parameter	Required	Notes
`id`	Yes	Saved-search ID

Example

curl -X DELETE "https://your-server.example.com/api/SavedSearches?id=3c0d6b36-3474-45b4-bfe9-c2eddf34d9a0" \
  -H "Authorization: Bearer USER_BEARER_TOKEN"