THtheirstack
Saved Searches

List Saved Searches

Changed on

Retrieve all active saved searches of the current team, including search filters, type, and creation date. Archived searches are left out, and so are the ones that hold a sales signal's filters, which you can still read by ID. Filter by user IDs or search type and sort by name, created, or updated date.

get/v0/saved_searches

Request

Query parameters

user_idsinteger[]

Get saved searches from users with these IDs. The IDs must be from people in the current users' team.

typesSavedSearchType[] nullable

Filter by type of search

order_by'name' | 'created_at' | 'updated_at'

Order by field

order_direction'asc' | 'desc'

Order direction

Response

Successful Response

idinteger required

ID of the saved search

namestring required

Name of the saved search

type'companies' | 'jobs' required
is_alert_activeboolean

Is the alert active

user_idinteger required

Owner of the saved search

team_idinteger required

Team of the saved search

created_atstring date-time required

Date and time when the saved search was created

updated_atstring date-time required

Date and time when the saved search was last updated

querystring nullable

Query of the request

pathstring nullable

Path of the request

querystring_paramsobject nullable

Dictionary containing the querystring parameters of the request.

is_archivedboolean

Is the saved search archived

has_active_webhooksboolean

Has active webhooks

origin'manual' | 'signal'
frequency'daily' | 'weekly'
emails_subscribedstring[] nullable

The creator's email, recorded when the saved search was created. Alerts are sent to the creator.

Example response

[
  {
    "body": {
      "order_by": [
        {
          "field": "relevance"
        }
      ],
      "company_name_or": [],
      "company_name_case_insensitive_or": [],
      "company_id_or": [],
      "company_id_not": [],
      "company_domain_or": [],
      "company_domain_not": [],
      "company_name_not": [],
      "company_name_partial_match_or": [],
      "company_name_partial_match_not": [],
      "company_linkedin_url_or": [],
      "property_exists_or": [],
      "property_exists_and": [],
      "limit": 25,
      "job_filters": {
        "job_title_or": [],
        "job_title_not": [],
        "job_title_pattern_and": [],
        "job_title_pattern_or": [],
        "job_title_pattern_not": [],
        "job_country_code_or": [],
        "job_country_code_not": [],
        "job_description_pattern_or": [],
        "job_description_pattern_not": [],
        "job_description_pattern_and": [],
        "job_description_contains_or": [],
        "job_description_contains_not": [],
        "job_description_pattern_case_sensitive_or": [],
        "workplace_types_or": [],
        "job_id_or": [],
        "job_id_not": [],
        "job_seniority_or": [],
        "job_location_pattern_or": [],
        "job_location_pattern_not": [],
        "job_location_or": [],
        "job_location_not": [],
        "url_domain_or": [],
        "url_domain_not": [],
        "employment_statuses_or": [],
        "property_exists_or": [],
        "property_exists_and": []
      }
    }
  }
]

Changes

  • aff0db87b504Revision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property /// to the response with the status

  • 18b9a76a04afRevision changes
    • info

      response property items/body/anyOf[subschema #1: CompanySearchFilters]/job_filters/anyOf[subschema #1: JobFilters]/job_description_pattern_and deprecated

    • info

      response property items/body/anyOf[subschema #1: CompanySearchFilters]/job_filters/anyOf[subschema #1: JobFilters]/job_description_pattern_not deprecated

    • info

      response property items/body/anyOf[subschema #1: CompanySearchFilters]/job_filters/anyOf[subschema #1: JobFilters]/job_description_pattern_or deprecated

    • info

      response property items/body/anyOf[subschema #2: JobSearchFilters]/job_description_pattern_and deprecated

    • info

      response property items/body/anyOf[subschema #2: JobSearchFilters]/job_description_pattern_not deprecated

    • info

      response property items/body/anyOf[subschema #2: JobSearchFilters]/job_description_pattern_or deprecated