Clay: Fields

List the filter fields available for a search source type.

Tool ID: clay_fields

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.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'clay_fields',
  {
    "source_type": "people"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute clay_fields --input '{
  "source_type": "people"
}' --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "fields": [
      {
        "name": "Example",
        "type": "example"
      }
    ],
    "guidance": {
      "behavior": [
        "example"
      ],
      "field_guidance": [
        {
          "id": "id_123",
          "text": "example"
        }
      ]
    },
    "source_type": "people"
  }
}

Use deepline tools get clay_fields --json for the latest machine-readable contract.

Input reference

Returns every filter field accepted by POST /search/filters-mode for the given source type, including each field’s type, description, allowed values, and usage guidance. Call this before creating a search to build valid filters.

Name	Type	Required	Default	Details
`payload.source_type`	`"people" \| "companies"`	Yes	—	Allowed: `people`, `companies`.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.fields`	`array`	Yes	—	—
`result.data.fields[].allowed_values`	`array`	No	—	—
`result.data.fields[].description`	`string`	No	—	—
`result.data.fields[].name`	`string`	Yes	—	—
`result.data.fields[].type`	`string`	Yes	—	—
`result.data.guidance`	`object`	Yes	—	—
`result.data.guidance.behavior`	`array`	Yes	—	—
`result.data.guidance.create_examples`	`array`	No	—	—
`result.data.guidance.create_examples[].intent`	`string`	Yes	—	—
`result.data.guidance.create_examples[].request`	`object`	Yes	—	—
`result.data.guidance.create_examples[].request.filters`	`record`	Yes	—	—
`result.data.guidance.create_examples[].request.source_type`	`"people" \| "companies"`	Yes	—	Allowed: `people`, `companies`.
`result.data.guidance.field_guidance`	`array`	Yes	—	—
`result.data.guidance.field_guidance[].fields`	`array`	No	—	—
`result.data.guidance.field_guidance[].id`	`string`	Yes	—	—
`result.data.guidance.field_guidance[].text`	`string`	Yes	—	—
`result.data.source_type`	`"people" \| "companies"`	Yes	—	Allowed: `people`, `companies`.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

Getting Started

GTM is code

Features

Deepline SDK beta

Integrations

API Reference

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation