> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Clay Enterprise: Clay Run Query Mode
> Run the query-mode iterator and return the next page of results (beta). Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.
Run the query-mode iterator and return the next page of results (beta).
Tool ID: `clay_run_query_mode`
## Run this action
Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.
```ts theme={null}
import { Deepline } from 'deepline';
const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
'clay_run_query_mode',
{
"search_id": "search_123"
},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={null}
deepline tools execute clay_run_query_mode --input '{
"search_id": "search_123"
}' --json
```
## Example response
The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.
```json theme={null}
{
"data": {
"data": [
{
"annual_revenue": "example",
"clay_company_id": 123,
"country": "US",
"description": "Example description",
"domain": "example.com",
"industry": "example",
"linkedin_url": "https://www.linkedin.com/in/jane-doe",
"location": "example",
"name": "Example",
"size": "example",
"total_funding_amount_range_usd": 1,
"type": "example"
}
],
"has_more": true,
"source_type": "companies"
}
}
```
Use `deepline tools get clay_run_query_mode --json` for the latest machine-readable contract.
## Input reference
Returns the next page of records for an existing query-mode search.
| Name | Type | Required | Default | Details |
| ------------------- | --------- | -------- | ------- | ------------------------- |
| `payload.search_id` | `string` | Yes | — | — |
| `payload.limit` | `integer` | No | `20` | Minimum: 1. Maximum: 500. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Returns the next page of records for an existing query-mode search.",
"properties": {
"search_id": {
"type": "string"
},
"limit": {
"type": "integer",
"default": 20,
"minimum": 1,
"maximum": 500
}
},
"required": [
"search_id"
],
"additionalProperties": false
}
```
## Output reference
Standard tool result payload.
| Name | Type | Required | Default | Details |
| ----------------------------------------------------- | ------------------------------------ | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.data` | `array` | Yes | — | — |
| `result.data.data[].clay_profile_id` | `number` | Yes | — | — |
| `result.data.data[].first_name` | `string \| null` | Yes | — | — |
| `result.data.data[].last_name` | `string \| null` | Yes | — | — |
| `result.data.data[].location` | `object` | Yes | — | — |
| `result.data.data[].location.city` | `string \| null` | Yes | — | — |
| `result.data.data[].location.name` | `string \| null` | Yes | — | — |
| `result.data.data[].location.state_or_province` | `string \| null` | Yes | — | — |
| `result.data.data[].matched_experiences` | `array` | Yes | — | — |
| `result.data.data[].matched_experiences[].company` | `string \| null` | Yes | — | — |
| `result.data.data[].matched_experiences[].end_date` | `string \| null` | Yes | — | — |
| `result.data.data[].matched_experiences[].location` | `string \| null` | Yes | — | — |
| `result.data.data[].matched_experiences[].start_date` | `string \| null` | Yes | — | — |
| `result.data.data[].matched_experiences[].title` | `string \| null` | Yes | — | — |
| `result.data.data[].name` | `string \| null` | Yes | — | — |
| `result.data.exhaustion_reason` | `"query_limit" \| "no_more_results"` | No | — | — |
| `result.data.has_more` | `boolean` | Yes | — | — |
| `result.data.period_quota` | `object` | No | — | — |
| `result.data.period_quota.limit` | `number` | Yes | — | — |
| `result.data.period_quota.remaining` | `number` | Yes | — | — |
| `result.data.period_quota.resets_at` | `string` | Yes | — | — |
| `result.data.period_quota.used` | `number` | Yes | — | — |
| `result.data.source_type` | `"people"` | Yes | — | — |
| `result.data.data[].annual_revenue` | `string \| null` | Yes | — | — |
| `result.data.data[].clay_company_id` | `number` | Yes | — | — |
| `result.data.data[].country` | `string \| null` | Yes | — | — |
| `result.data.data[].description` | `string \| null` | Yes | — | — |
| `result.data.data[].domain` | `string \| null` | Yes | — | — |
| `result.data.data[].industry` | `string \| null` | Yes | — | — |
| `result.data.data[].linkedin_url` | `string \| null` | Yes | — | — |
| `result.data.data[].size` | `string \| null` | Yes | — | — |
| `result.data.data[].total_funding_amount_range_usd` | `number \| null` | Yes | — | — |
| `result.data.data[].type` | `string \| null` | Yes | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"description": "Provider response payload.",
"anyOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"clay_profile_id": {
"type": "number"
},
"first_name": {
"type": [
"string",
"null"
]
},
"last_name": {
"type": [
"string",
"null"
]
},
"location": {
"type": "object",
"properties": {
"city": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"state_or_province": {
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"city",
"state_or_province"
],
"additionalProperties": false
},
"matched_experiences": {
"type": "array",
"items": {
"type": "object",
"properties": {
"company": {
"type": [
"string",
"null"
]
},
"end_date": {
"type": [
"string",
"null"
]
},
"location": {
"type": [
"string",
"null"
]
},
"start_date": {
"type": [
"string",
"null"
]
},
"title": {
"type": [
"string",
"null"
]
}
},
"required": [
"company",
"title",
"location",
"start_date",
"end_date"
],
"additionalProperties": false
}
},
"name": {
"type": [
"string",
"null"
]
}
},
"required": [
"clay_profile_id",
"name",
"first_name",
"last_name",
"location",
"matched_experiences"
],
"additionalProperties": false
}
},
"exhaustion_reason": {
"type": "string",
"enum": [
"query_limit",
"no_more_results"
]
},
"has_more": {
"type": "boolean"
},
"period_quota": {
"type": "object",
"properties": {
"limit": {
"type": "number"
},
"remaining": {
"type": "number"
},
"resets_at": {
"type": "string"
},
"used": {
"type": "number"
}
},
"required": [
"limit",
"used",
"remaining",
"resets_at"
],
"additionalProperties": false
},
"source_type": {
"type": "string",
"const": "people"
}
},
"required": [
"data",
"has_more",
"source_type"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"annual_revenue": {
"type": [
"string",
"null"
]
},
"clay_company_id": {
"type": "number"
},
"country": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"domain": {
"type": [
"string",
"null"
]
},
"industry": {
"type": [
"string",
"null"
]
},
"linkedin_url": {
"type": [
"string",
"null"
]
},
"location": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"size": {
"type": [
"string",
"null"
]
},
"total_funding_amount_range_usd": {
"type": [
"number",
"null"
]
},
"type": {
"type": [
"string",
"null"
]
}
},
"required": [
"clay_company_id",
"name",
"size",
"type",
"domain",
"country",
"industry",
"location",
"description",
"linkedin_url",
"annual_revenue",
"total_funding_amount_range_usd"
],
"additionalProperties": false
}
},
"exhaustion_reason": {
"type": "string",
"enum": [
"query_limit",
"no_more_results"
]
},
"has_more": {
"type": "boolean"
},
"period_quota": {
"type": "object",
"properties": {
"limit": {
"type": "number"
},
"remaining": {
"type": "number"
},
"resets_at": {
"type": "string"
},
"used": {
"type": "number"
}
},
"required": [
"limit",
"used",
"remaining",
"resets_at"
],
"additionalProperties": false
},
"source_type": {
"type": "string",
"const": "companies"
}
},
"required": [
"data",
"has_more",
"source_type"
],
"additionalProperties": false
}
]
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Deepline cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
## Related documentation
* [Clay Enterprise provider guide](/docs/providers/clay/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)