---
title: "Get field by id"
method: GET
path: "/api/v11/Field/{id}"
tags: ["Field"]
---

# Get field by id

`GET /api/v11/Field/{id}`

Gets a single field by its id

## Path parameters

- `id` integer, required

## Headers

- `X-HawkSearch-ApiKey` string, required

## Response `200`

OK

- FieldModel
  - `FieldId` integer
  - `SyncGuid` string, uuid
  - `Label` string
  - `Name` string, required
  - `IsPrimaryKey` boolean, required
  - `Type` string
  - `FieldType` string, required
  - `Boost` integer
  - `FacetHandler` integer
  - `IsOutput` boolean, required
  - `IsShingle` boolean, required
  - `IsBestFragment` boolean, required
  - `IsDictionary` boolean, required
  - `IsSort` boolean, required
  - `IsPrefix` boolean
  - `IsHidden` boolean, required
  - `IsCompare` boolean, required
  - `SortOrder` integer
  - `PartialQuery` string
  - `IsKeywordText` boolean, required
  - `IsQuery` boolean, required
  - `IsQueryText` boolean, required
  - `SkipCustom` boolean, required
  - `StripHtml` boolean, required
  - `MinNGramAnalyzer` integer
  - `MaxNGramAnalyzer` integer
  - `CoordinateType` integer
  - `OmitNorms` boolean
  - `ItemMapping` string
  - `DefaultValue` string
  - `UseForPrediction` boolean
  - `CopyTo` string
  - `Analyzer` string
  - `DoNotStore` boolean
  - `Tags` string
  - `Iterations` integer[]
  - `AnalyzerLanguage` string
  - `PreviewMapping` string
  - `OmitTfAndPos` boolean
  - `CreateDate` string, date-time
  - `ModifyDate` string, date-time
  - `IsChild` boolean
  - `IsHierarchical` boolean

---

[API](https://skmtc.net/hawksearch/apis/hawksearch-elasticsearch-indexingapi.md) · [All operations](https://skmtc.net/hawksearch/apis/hawksearch-elasticsearch-indexingapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hawksearch/hawksearch-elasticsearch-indexingapi/versions/24cba7bf3468/schema)