> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Clay

> Clay is a go-to-market data enrichment and workflow automation platform for searching people and companies, running routines, and querying workspace tables.

![Clay logo](https://mintcdn.com/composio-preview/NPf8agM6UrvZD-Iu/images/toolkits/clay.svg?fit=max\&auto=format\&n=NPf8agM6UrvZD-Iu\&q=85\&s=085aa8beb6f929b22396cc7ec55e0061)

* **Category:** sales & crm
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 8
* **Triggers:** 0
* **Slug:** `CLAY`
* **Version:** 20261101\_00
* **Instant:** Supported on the latest version. Support varies by tool.

## Tools

> [accordion] Continue Search
>
> **Slug:** `CLAY_CONTINUE_SEARCH`
>
> Consume one next page from an existing Clay query-mode search. Each call advances Clay's server-side iterator and consumes search quota; call again only while has\_more is true.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.074 per requested result (1–50); charged for the full limit.
>
> #### Input Parameters
>
> **limit** `integer` *required*
>
> Required maximum number of records to request for this page (1–50).
>
> **search\_id** `string` *required*
>
> Copy search\_id from your own Search People or Companies response. Reuse that ID only while has\_more is true; do not invent an identifier.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Credit Balance
>
> **Slug:** `CLAY_GET_CREDIT_BALANCE`
>
> Return the current Clay workspace's remaining spendable data credits and, when available, action-execution balance. Free; no charge.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Current User
>
> **Slug:** `CLAY_GET_CURRENT_USER`
>
> Return the Clay user and workspace associated with the connected Public API key.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Privacy Delete Status
>
> **Slug:** `CLAY_GET_PRIVACY_DELETE_STATUS`
>
> Check an existing Audiences privacy deletion job in your Clay workspace once, including tracked cascading cleanup. HTTP 202 means queued or in progress; continue polling. HTTP 200 means complete or failed: inspect status, since failed means cleanup may be partial. finished stays 0 until the entire job completes, then equals total; it is not a partial-progress count. Completed and failed job statuses are retained for three days after completion or failure.
>
> #### Input Parameters
>
> **job\_id** `string` *required*
>
> Deletion job ID returned when a privacy deletion request was queued.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Routine Batch Results
>
> **Slug:** `CLAY_GET_ROUTINE_BATCH_RESULTS`
>
> Check an existing asynchronous Clay batch routine run once. Returns progress (HTTP 202) or a terminal status (HTTP 200) with a result\_url on completion. validation\_failed and processing\_failed are terminal failure statuses: callers must inspect status and error, since HTTP 200 does not imply batch success. Does not paginate, automatically poll, or download the result file.
>
> #### Input Parameters
>
> **routine\_run\_id** `string` *required*
>
> Batch routine run identifier returned when starting a batch run.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Routine Batch Upload URL
>
> **Slug:** `CLAY_GET_ROUTINE_BATCH_UPLOAD_URL`
>
> Create a presigned upload URL and file ID for a Clay routine batch. The caller must PUT a JSONL file to upload\_url with Content-Type application/x-ndjson, then call Start Routine Batch with the returned file\_id and the same routine\_id. Each JSONL line contains an id and inputs object. Returns the URL without fetching it, uploading data, or starting a run.
>
> #### Input Parameters
>
> **routine\_id** `string` *required*
>
> Clay routine identifier for the batch, such as function:t\_abc123.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Routine Run Results
>
> **Slug:** `CLAY_GET_ROUTINE_RUN_RESULTS`
>
> Check progress or fetch one page of results for an existing inline Clay routine run. Returns progress while processing and an explicit next\_cursor when another terminal result page is available.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum completed item results to return in this page (1-100).
>
> **cursor** `string`
>
> Continuation cursor returned as next\_cursor by a previous result page. Omit for the first page or a progress check.
>
> **routine\_run\_id** `string` *required*
>
> Routine run identifier returned by Run Routine.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Search Query Reference
>
> **Slug:** `CLAY_GET_SEARCH_QUERY_REFERENCE`
>
> Return Clay's current advanced-search field and grammar reference for composing people or company queries.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0 per reference lookup
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Workflow Runs Query Reference
>
> **Slug:** `CLAY_GET_WORKFLOW_RUNS_QUERY_REFERENCE`
>
> Get Clay's workflow-run query reference (beta) as Markdown. Use its queryable run fields, node predicates, content search, and grammar to author a workflow-run query.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Privacy Delete People
>
> **Slug:** `CLAY_PRIVACY_DELETE_PEOPLE`
>
> Queue deletion of people from Clay Audiences for privacy-related requests in the workspace associated with the API key. Matches any of 1–100 email, LinkedIn slug, or phone identifiers. Set dry\_run=true to preview the unique matching count, including archived people, without queueing deletion. HTTP 200 returns dry\_run or no\_matches; HTTP 202 returns in\_progress and a deletion job ID. Queued deletion is asynchronous; acceptance does not mean deletion has completed.
>
> #### Input Parameters
>
> **dry\_run** `boolean`
>
> Preview the matching count without queueing deletion. Defaults to false.
>
> **person\_identifiers** `array` *required*
>
> 1–100 identifiers. People matching any identifier in the API key's workspace are selected.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Query Table Rows
>
> **Slug:** `CLAY_QUERY_TABLE_ROWS`
>
> Run a structured query across caller-identified Clay workspace tables and return one page of rows, with field metadata when available; tables require Enterprise access. Grouped, aggregate, and custom-ordered queries cannot use cursor pagination and may return truncated results.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum rows to return in this page (1-100).
>
> **query** `object` *required*
>
> Structured query over caller-identified Clay workspace tables.
>
> **cursor** `string`
>
> Opaque cursor returned in cursor by the previous page. Repeat the same query, including its table IDs, when continuing.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Query Workflow Runs
>
> **Slug:** `CLAY_QUERY_WORKFLOW_RUNS`
>
> Search Clay workflow runs using the official beta query API. Select returns one page newest-first with a continuation cursor; count returns the number of matches. Obtain query grammar from GET /workflows/runs/query/reference. Results are eventually consistent: recent runs or status changes may take a few seconds to appear.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Optional maximum runs per page (1-100); omit to use Clay's default.
>
> **query** `string` *required*
>
> Clay workflow-run query in select or count mode. Obtain the grammar from GET /workflows/runs/query/reference. Repeat the query when paging.
>
> **cursor** `string`
>
> Opaque cursor returned by this action for the next page of matching runs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run Routine
>
> **Slug:** `CLAY_RUN_ROUTINE`
>
> Start a Clay routine for 1-100 items, poll it for a bounded time, and return completed item results or the current run ID and progress. Execution may incur Clay charges and can notify an existing webhook when webhook\_id is provided.
>
> #### Input Parameters
>
> **items** `array` *required*
>
> One to 100 independently identified routine inputs.
>
> **routine\_id** `string` *required*
>
> Clay-managed or custom-function routine identifier to execute.
>
> **webhook\_id** `string`
>
> Existing Clay webhook identifier to notify about the run, if desired.
>
> **wait\_timeout\_seconds** `number`
>
> Maximum seconds to wait before returning the latest in-progress state.
>
> **poll\_interval\_seconds** `number`
>
> Seconds between result checks while the run remains in progress.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search People or Companies
>
> **Slug:** `CLAY_SEARCH_PEOPLE_OR_COMPANIES`
>
> Create a Clay query-mode people or company search and consume its first result page. Count-mode and jobs queries are not supported. This advances a stateful search iterator and consumes Clay search quota; use Continue Search only while has\_more is true.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.074 per requested result (1–50); charged for the full limit.
>
> #### Input Parameters
>
> **limit** `integer` *required*
>
> Required maximum number of records to request for the first page (1–50).
>
> **query** `string` *required*
>
> Clay advanced-search query for people or companies. Call Get Search Query Reference first when the grammar or available fields are unknown. Count-mode and jobs queries are not supported by Clay query-mode.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Start Routine Batch
>
> **Slug:** `CLAY_START_ROUTINE_BATCH`
>
> Start an asynchronous Clay routine batch over a previously uploaded JSONL file. First call Get Routine Batch Upload URL and PUT the JSONL file to its upload\_url, then pass the returned file\_id and the same routine\_id here. Optionally notify a registered webhook when the run finishes. Returns an accepted run ID and in\_progress status, not completed results. Use Get Routine Batch Results to retrieve the batch output.
>
> #### Input Parameters
>
> **file\_id** `string` *required*
>
> File ID returned by Get Routine Batch Upload URL after the caller has uploaded the JSONL input file.
>
> **routine\_id** `string` *required*
>
> Clay routine identifier for the batch, such as function:t\_abc123.
>
> **webhook\_id** `string`
>
> ID of a registered Clay webhook to notify when the run finishes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
