Run a search, then enrich with a function

This is the simplest high-value Clay developer flow:

Use Searches to find companies or people.
Pass the results into a routine.
Use Clay-managed functions to enrich the records.

For example, you might search for heads of sales at B2B SaaS companies, then run a Clay-managed function to find work emails.

1. Run a search

Discover valid criteria, create a search, then fetch the first page of results. Use advanced search (beta) by default; use filters mode if you prefer its older JSON structure or have existing filters-mode searches.

Advanced search (beta)
Filters mode

Fetch the query reference before writing the query.

curl --request GET \
  --url https://api.clay.com/public/v0/search/query-mode/reference \
  --header "clay-api-key: $CLAY_PUBLIC_API_KEY"

QUERY='select from people where experiences.any('\
'is_current = true and '\
'job_title is_similar_to ("VP Sales", "Head of Sales") and '\
'company.estimated_employee_count >= 500 and '\
'company.industry = "Software Development")'

SEARCH_ID=$(curl --request POST \
  --url https://api.clay.com/public/v0/search/query-mode \
  --header "Content-Type: application/json" \
  --header "clay-api-key: $CLAY_PUBLIC_API_KEY" \
  --data "$(jq -n --arg query "$QUERY" '{query: $query}')" \
  | jq -r '.search_id')

curl --request POST \
  --url "https://api.clay.com/public/v0/search/query-mode/$SEARCH_ID/run" \
  --header "Content-Type: application/json" \
  --header "clay-api-key: $CLAY_PUBLIC_API_KEY" \
  --data '{ "limit": 10 }'

Discover the available filters for the source type before creating the search.

curl --request GET \
  --url "https://api.clay.com/public/v0/search/filters-mode/fields?source_type=people" \
  --header "clay-api-key: $CLAY_PUBLIC_API_KEY"

SEARCH_ID=$(curl --request POST \
  --url https://api.clay.com/public/v0/search/filters-mode \
  --header "Content-Type: application/json" \
  --header "clay-api-key: $CLAY_PUBLIC_API_KEY" \
  --data '{
    "source_type": "people",
    "filters": {
      "job_title_keywords": ["head of sales"],
      "company_industries_include": ["Software Development"],
      "location_cities_include": ["New York"]
    }
  }' | jq -r '.search_id')

curl --request POST \
  --url "https://api.clay.com/public/v0/search/filters-mode/$SEARCH_ID/run" \
  --header "Content-Type: application/json" \
  --header "clay-api-key: $CLAY_PUBLIC_API_KEY" \
  --data '{ "limit": 10 }'

2. Choose a function

Use a Clay-managed function when Clay already provides the enrichment you need, such as finding emails, phone numbers, company data, technology data, funding, or job openings.

Clay-managed functions

Learn when to use Clay-provided functions.

3. Run the function

Run the function routine on the records you want to enrich.

echo '{"items":[{"id":"person-1","inputs":{"domain":"example.com","full_name":"Ada Lovelace"}}]}' \
  | clay routines runs start function:t_abc123 --input -

Then fetch the result:

clay routines runs get run_abc123

Start here

Core primitives

Recipes

Concepts

API Reference

Run a search, then enrich with a function

1. Run a search

2. Choose a function

Clay-managed functions

3. Run the function

Next steps

Searches

Batch runs

​1. Run a search

​2. Choose a function

Clay-managed functions

​3. Run the function

​Next steps

Searches

Batch runs

1. Run a search

2. Choose a function

3. Run the function

Next steps