> ## Documentation Index
> Fetch the complete documentation index at: https://developers.clay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# search filters-mode fields

> List the filter fields available for a search source type.

List every filter field you can pass to [`clay search filters-mode create`](/cli/reference/search-create) `--filters`, along with each field's type, description, allowed values, and usage guidance. Use it to build a valid search instead of guessing at field names or intent.

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
clay search filters-mode fields --source-type <type>
```

## Flags

| Flag                   | Description                                         |
| ---------------------- | --------------------------------------------------- |
| `--source-type <type>` | What to search for. One of `people` or `companies`. |

## Output

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "sourceType": "people",
  "fields": [
    {
      "name": "job_title_keywords",
      "type": "string[]",
      "description": "Keywords to match against a person's job title.",
      "allowedValues": ["..."]
    }
  ],
  "guidance": {
    "behavior": ["..."],
    "fieldGuidance": [
      {
        "id": "job-title",
        "text": "Use job_title_keywords for role matching.",
        "fields": ["job_title_keywords"]
      }
    ],
    "createExamples": [
      {
        "intent": "Growth engineers in San Francisco",
        "request": {
          "source_type": "people",
          "filters": { "job_title_keywords": ["growth engineer"] }
        }
      }
    ]
  }
}
```

| Field                               | Type      | Description                                                                                          |
| ----------------------------------- | --------- | ---------------------------------------------------------------------------------------------------- |
| `sourceType`                        | string    | The source type the fields belong to.                                                                |
| `fields[].name`                     | string    | Filter field name to use as a key in `--filters`.                                                    |
| `fields[].type`                     | string    | Human-readable type, e.g. `string[]`, `string`, `number`, or `boolean`.                              |
| `fields[].description`              | string    | What the field matches. Omitted when not set.                                                        |
| `fields[].allowedValues`            | string\[] | Present only for enum fields; the closed set of accepted values. Omitted for non-enum fields.        |
| `guidance.behavior`                 | string\[] | General guidance on how filters behave.                                                              |
| `guidance.fieldGuidance[]`          | object    | Per-topic guidance; `fields` lists the field names each note applies to.                             |
| `guidance.createExamples[].intent`  | string    | Plain-language description of what the example search finds.                                         |
| `guidance.createExamples[].request` | object    | A request shaped like the [`clay search filters-mode create`](/cli/reference/search-create) payload. |

Read the guidance before creating a search — the field list alone does not explain which field to use for a given intent.

## Errors

| Code               | Exit | Notes                                                                              |
| ------------------ | ---- | ---------------------------------------------------------------------------------- |
| `validation_error` | 2    | `--source-type` is not `people` or `companies`.                                    |
| `auth_forbidden`   | 3    | The API key lacks access, or the public-API beta is not enabled for the workspace. |

## Examples

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
clay search filters-mode fields --source-type people
clay search filters-mode fields --source-type companies | jq '.guidance.fieldGuidance[] | .id'
clay search filters-mode fields --source-type people | jq '.guidance.createExamples[0].request'
clay search filters-mode fields --source-type companies | jq '.fields[] | select(.allowedValues) | .name'
```