> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/clay.md).

# Clay

Integration with Clay for searching its GTM database of people and companies and running Clay enrichment routines.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Clay      | API Key        |

#### Clay

Connect to Clay with an API key to search its GTM database of people and companies and run Clay enrichment routines.

**Set up in Clay**

1. Prepare the Clay account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** Your personal Clay API key. Create one in Clay under Settings > Account > API keys. The key is tied to your Clay user and their workspace access.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Clay**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                                                                                                                           |
| ------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API Key       | Yes      | Your personal Clay API key. Create one in Clay under Settings > Account > API keys. The key is tied to your Clay user and their workspace access. [Provider instructions](https://app.clay.com/workspaces/~/settings/account?accountTab=api-keys-beta). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Clay** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Search records

Find people or companies in Clay's GTM database using a JSON filters object, and return the matching records.

**Inputs**

| Field           | Type            | Required | Description                                                                                                                                                                                                                     |
| --------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Search for      | select (string) | Yes      | Whether to search Clay's people records or its company records. Available values: People, Companies. Default: people.                                                                                                           |
| Filters         | object          | No       | Clay filters, as filter name and value pairs. A single value is fine where Clay expects a list -- it is wrapped automatically. Use the List Filter Fields action to see which filter names and values this source type accepts. |
| Maximum results | integer         | No       | The maximum number of records to return. Clay bills search results against your workspace quota, so keep this as low as the workflow needs. Minimum: 1. Maximum: 500. Default: 25.                                              |
| Search ID       | string          | No       | Continue an earlier search instead of starting a new one, using the Search ID it returned. When set, the source type and filters are ignored.                                                                                   |

**Outputs**

| Field        | Type          | Description                                                  |
| ------------ | ------------- | ------------------------------------------------------------ |
| Records      | object\_array | The matching people or company records from Clay.            |
| Record count | integer       | How many records were returned.                              |
| Search ID    | string        | Pass this back as the Search ID to fetch more results.       |
| Has more     | boolean       | Whether more records are available beyond the ones returned. |

#### List filter fields

List the filters a Clay people or company search accepts, with their types, allowed values, and worked examples.

**Inputs**

| Field      | Type            | Required | Description                                                                                                                             |
| ---------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| Search for | select (string) | Yes      | Whether to describe the filters for Clay's people records or its company records. Available values: People, Companies. Default: people. |

**Outputs**

| Field              | Type          | Description                                                   |
| ------------------ | ------------- | ------------------------------------------------------------- |
| Filter fields      | object\_array | Every filter this source type accepts.                        |
| Filter field count | integer       | How many filter fields were returned.                         |
| Guidance           | object        | Clay's notes and worked examples for combining these filters. |

#### Run routine

Run a Clay function or Workflow against up to 100 items and return each item's enriched result.

**Inputs**

| Field               | Type     | Required | Description                                                                                                                                                                                                       |
| ------------------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Routine ID          | string   | No       | The Clay routine to run. Custom functions use the form 'function:t\_...'. Required unless a Routine Run ID is supplied to collect an earlier run.                                                                 |
| Items               | textarea | No       | A JSON array of 1 to 100 records to run the routine against, one object per record. Use the routine's own input field names as the keys, copied exactly as Clay displays them: \[{"Company Domain": "clay.com"}]. |
| Wait for completion | boolean  | No       | Wait for the routine run to finish and return its results. Turn this off to start the run and return immediately with its Routine Run ID. Default: true.                                                          |
| Webhook ID          | string   | No       | Optionally notify a Clay webhook when the run finishes, so another system can react without polling.                                                                                                              |
| Routine Run ID      | string   | No       | Collect the results of a run that was already started, instead of starting a new one. When set, the routine ID and items are ignored.                                                                             |

**Outputs**

| Field          | Type          | Description                                                                   |
| -------------- | ------------- | ----------------------------------------------------------------------------- |
| Results        | object\_array | One entry per input item, matched back by the id you supplied.                |
| Status         | string        | Whether the run has finished.                                                 |
| Routine Run ID | string        | Pass this back as the Routine Run ID to collect results later.                |
| Total items    | integer       | How many items the run covers.                                                |
| Finished items | integer       | How many items have finished processing.                                      |
| Failed items   | integer       | How many items failed. Items fail individually without failing the whole run. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/clay.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
