Run the query-mode iterator and return the next page of results (beta)

Returns the next page of records for an existing query-mode search.

POST https://api.clay.com/public/v0/search/query-mode/{search_id}/run

Run the query-mode iterator and return the next page of results (beta)

cURL

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: <api-key>' \
  --data '{
  "limit": 20
}'

200

{
  "data": [
    {
      "clay_profile_id": 123,
      "first_name": "<string>",
      "last_name": "<string>",
      "location": {
        "city": "<string>",
        "name": "<string>",
        "state_or_province": "<string>"
      },
      "matched_experiences": [
        {
          "company": "<string>",
          "end_date": "<string>",
          "location": "<string>",
          "start_date": "<string>",
          "title": "<string>"
        }
      ],
      "name": "<string>"
    }
  ],
  "has_more": true,
  "source_type": "<string>",
  "period_quota": {
    "limit": 123,
    "remaining": 123,
    "resets_at": "<string>",
    "used": 123
  }
}

Authorizations

clay-api-key · string · header · required

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

Path Parameters

search_id · string · required

Body

application/json

Body

limit · integer · default: 20

Required range: 1 <= x <= 500

Response

200

application/json

200

Option 1

Option 2

data · object[] · required

Show child attributes

has_more · boolean · required

source_type · string · required

Allowed value: "people"

exhaustion_reason · enum<string>

Available options: query_limit, no_more_results

period_quota · object

Show child attributes