---
title: Get Field Extractor
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/python)

[Field Extractors](https://developers.cloudflare.com/api/python/resources/field_extractors)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Get Field Extractor

field\_extractors.get(strextractor, FieldExtractorGetParams\*\*kwargs) -> [FieldExtractorGetResponse](<https://developers.cloudflare.com/api/python/resources/field_extractors#(resource)%20field_extractors%20%3E%20(model)%20field_extractor_get_response%20%3E%20(schema)>)

GET/accounts/{account\_id}/field\_extractors/{extractor}

Retrieves the custom extraction rules configured for a given extractor type.

##### Security

<details>

<summary>API Token</summary>



The preferred authorization scheme for interacting with the Cloudflare API. <a href="https://developers.cloudflare.com/fundamentals/api/get-started/create-token/">Create a token</a>.

**Example:**<code>Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY</code>

</details>

<details>

<summary>API Email + API Key</summary>



The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

**Example:**<code>X-Auth-Email: user@example.com</code>

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

**Example:**<code>X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194</code>

</details>

##### ParametersExpand Collapse

account\_id: str

Cloudflare account ID.

minLength1

[Link to this property](<#(resource)%20field_extractors%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>)

extractor: str

Extractor type.

minLength1

[Link to this property](<#(resource)%20field_extractors%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20extractor%20%3E%20(schema)>)

##### ReturnsExpand Collapse

<details>

<summary>

class FieldExtractorGetResponse: …

</summary>

extractor: str

Extractor type.

<a href="#(resource)%20field_extractors%20%3E%20(model)%20field_extractor_get_response%20%3E%20(schema)%20%3E%20(property)%20extractor">Link to this property</a>

<details>

<summary>

rules: List\[Rule]

</summary>

<details>

<summary>

fields: List\[RuleField]

</summary>

expression: str

Wirefilter value expression.

<a href="#(resource)%20field_extractors%20%3E%20(model)%20field_extractor_get_response%20%3E%20(schema)%20%3E%20(property)%20rules%20%3E%20(items)%20%3E%20(property)%20fields%20%3E%20(items)%20%3E%20(property)%20expression">Link to this property</a>

name: str

Field name.

<a href="#(resource)%20field_extractors%20%3E%20(model)%20field_extractor_get_response%20%3E%20(schema)%20%3E%20(property)%20rules%20%3E%20(items)%20%3E%20(property)%20fields%20%3E%20(items)%20%3E%20(property)%20name">Link to this property</a>

</details>

<a href="#(resource)%20field_extractors%20%3E%20(model)%20field_extractor_get_response%20%3E%20(schema)%20%3E%20(property)%20rules%20%3E%20(items)%20%3E%20(property)%20fields">Link to this property</a>

ref: str

Stable rule identifier.

<a href="#(resource)%20field_extractors%20%3E%20(model)%20field_extractor_get_response%20%3E%20(schema)%20%3E%20(property)%20rules%20%3E%20(items)%20%3E%20(property)%20ref">Link to this property</a>

description: Optional\[str]

Human-readable rule description.

<a href="#(resource)%20field_extractors%20%3E%20(model)%20field_extractor_get_response%20%3E%20(schema)%20%3E%20(property)%20rules%20%3E%20(items)%20%3E%20(property)%20description">Link to this property</a>

</details>

<a href="#(resource)%20field_extractors%20%3E%20(model)%20field_extractor_get_response%20%3E%20(schema)%20%3E%20(property)%20rules">Link to this property</a>

</details>

[Link to this property](<#(resource)%20field_extractors%20%3E%20(model)%20field_extractor_get_response%20%3E%20(schema)>)

### Get Field Extractor

Python

HTTPTypeScriptPythonGoTerraform

```
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
field_extractor = client.field_extractors.get(
    extractor="llm_prompts",
    account_id="123456",
)
print(field_extractor.extractor)
```

200 example

```
{
  "errors": [
    {
      "code": 0,
      "message": "message",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": {
    "extractor": "llm_prompts",
    "rules": [
      {
        "fields": [
          {
            "expression": "filter(http.request.body.json.strings.values, http.request.body.json.strings.pointers[*] matches \"^/messages/\\\\d+/content$\")",
            "name": "prompt"
          }
        ],
        "ref": "openai-chat",
        "description": "description"
      }
    ]
  },
  "success": true
}
```

##### Returns Examples

200 example

```
{
  "errors": [
    {
      "code": 0,
      "message": "message",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": {
    "extractor": "llm_prompts",
    "rules": [
      {
        "fields": [
          {
            "expression": "filter(http.request.body.json.strings.values, http.request.body.json.strings.pointers[*] matches \"^/messages/\\\\d+/content$\")",
            "name": "prompt"
          }
        ],
        "ref": "openai-chat",
        "description": "description"
      }
    ]
  },
  "success": true
}
```