Create a search from structured filters

POST

https://api.clay.com/public/v0

searches

curl --request POST \
  --url https://api.clay.com/public/v0/searches \
  --header 'Content-Type: application/json' \
  --header 'clay-api-key: <api-key>' \
  --data '{
  "filters": {}
}'

{
  "search_id": "<string>"
}

Authorizations

clay-api-key

string

header

required

Personal API key tied to your Clay user. Create one under Settings → Account in the Clay app.

Body

application/json

Body

filters

object

required

Show child attributes

source_type

enum<string>

required

Available options:

people,

companies

Response

200

search_id

string

required

List the filter fields available for a search source typeReturns every filter field accepted by POST /searches for the given source type, including each field's type, description, allowed values, and usage guidance. Call this before creating a search to build valid filters.

Create a search from structured filters

curl --request POST \
  --url https://api.clay.com/public/v0/searches \
  --header 'Content-Type: application/json' \
  --header 'clay-api-key: <api-key>' \
  --data '{
  "filters": {}
}'

{
  "search_id": "<string>"
}