get_saved_search

Read a saved search by id.

get_saved_search

Read a saved search by id.

Safety class: C · API type: portal · Min version:

📘

Confinement

Class C: read-only; reference only saved searches you created. Non-prod only.

Signatures

def get_saved_search(sdk, saved_search_id):
    """Read a saved search by id; return the dict or None."""
    return sdk.get_saved_search(saved_search_id)
export async function getSavedSearch(sdk, savedSearchId) {
    // Read a saved search by id.
    return await sdk.getSavedSearch(savedSearchId);
}

Parameters

Parameter (Python)Parameter (JS)TypeRequiredNotes
sdksdkNomad_SDKyes
saved_search_idsavedSearchIdstryese.g. <saved-search-uuid>

Returns

dict | None — the saved-search record; None if not found.

Errors

  • 401 unauthenticated
  • InvalidAPITypeException on a non-portal session
  • 404 not found

See also: Python ↔ JS naming map · Return shapes.