Skip to main content
Clay logo
  • 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

Slug: CLAY_CONTINUE_SEARCHConsume 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

integer
required
Required maximum number of records to request for this page (1–50).
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLAY_GET_CREDIT_BALANCEReturn the current Clay workspace’s remaining spendable data credits and, when available, action-execution balance. Free; no charge.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLAY_GET_CURRENT_USERReturn the Clay user and workspace associated with the connected Public API key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLAY_GET_PRIVACY_DELETE_STATUSCheck 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

string
required
Deletion job ID returned when a privacy deletion request was queued.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLAY_GET_ROUTINE_BATCH_RESULTSCheck 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

string
required
Batch routine run identifier returned when starting a batch run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLAY_GET_ROUTINE_BATCH_UPLOAD_URLCreate 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

string
required
Clay routine identifier for the batch, such as function:t_abc123.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLAY_GET_ROUTINE_RUN_RESULTSCheck 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

integer
Maximum completed item results to return in this page (1-100).
string
Continuation cursor returned as next_cursor by a previous result page. Omit for the first page or a progress check.
string
required
Routine run identifier returned by Run Routine.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLAY_GET_SEARCH_QUERY_REFERENCEReturn 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLAY_GET_WORKFLOW_RUNS_QUERY_REFERENCEGet 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLAY_PRIVACY_DELETE_PEOPLEQueue 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

boolean
Preview the matching count without queueing deletion. Defaults to false.
array
required
1–100 identifiers. People matching any identifier in the API key’s workspace are selected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLAY_QUERY_TABLE_ROWSRun 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

integer
Maximum rows to return in this page (1-100).
object
required
Structured query over caller-identified Clay workspace tables.
string
Opaque cursor returned in cursor by the previous page. Repeat the same query, including its table IDs, when continuing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLAY_QUERY_WORKFLOW_RUNSSearch 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

integer
Optional maximum runs per page (1-100); omit to use Clay’s default.
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.
string
Opaque cursor returned by this action for the next page of matching runs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLAY_RUN_ROUTINEStart 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

array
required
One to 100 independently identified routine inputs.
string
required
Clay-managed or custom-function routine identifier to execute.
string
Existing Clay webhook identifier to notify about the run, if desired.
number
Maximum seconds to wait before returning the latest in-progress state.
number
Seconds between result checks while the run remains in progress.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLAY_SEARCH_PEOPLE_OR_COMPANIESCreate 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

integer
required
Required maximum number of records to request for the first page (1–50).
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLAY_START_ROUTINE_BATCHStart 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

string
required
File ID returned by Get Routine Batch Upload URL after the caller has uploaded the JSONL input file.
string
required
Clay routine identifier for the batch, such as function:t_abc123.
string
ID of a registered Clay webhook to notify when the run finishes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not