---
title: "Returns a search algorithm"
method: GET
path: "/search-algorithm/{id}"
tags: ["Search algorithm"]
---

# Returns a search algorithm

`GET /search-algorithm/{id}`

## Request

- The document declares no server URL.
- Auth: API key in header `TWN-InstanceKey` and API key in header `TWN-Authentication`

## Path parameters

- `id` integer, required

## Response `200`

OK

- union: Base model for a search algorithm
  - object
    - `discriminator` 'ApiSearchAlgorithmExactMatch', required
    - `AttributeId` integer, nullable: Optional linked attribute id
    - `NumberRecognitionRemoveString` string, nullable: String removed during number recognition
    - `SearchAlgorithmId` integer: Unique id of the search algorithm
    - `Sequence` integer: Execution order of the algorithm
    - `Weight` number, double: Weight of the algorithm
    - `StopWhenResultsFound` boolean: Stops when results were found
    - `Enabled` boolean: Indicates whether the search algorithm is enabled
  - object
    - `discriminator` 'ApiSearchAlgorithmWord', required
    - `UseFullTextRank` boolean, nullable: Enables full text rank usage
    - `EnableConjugations` boolean, nullable: Enables conjugations
    - `MatchStart` boolean, nullable: Matches on start of terms
    - `NumberRecognitionRemoveString` string, nullable: String removed during number recognition
    - `SearchAlgorithmAttributes` ApiSearchAlgorithmAttribute[]: Attributes linked to this algorithm
      - `AttributeId` integer: Linked attribute id
      - `HasPriority` boolean: Indicates priority
      - `UseAutocorrect` boolean: Enables autocorrect for the attribute
    - `SearchAlgorithmId` integer: Unique id of the search algorithm
    - `Sequence` integer: Execution order of the algorithm
    - `Weight` number, double: Weight of the algorithm
    - `StopWhenResultsFound` boolean: Stops when results were found
    - `Enabled` boolean: Indicates whether the search algorithm is enabled
  - object
    - `discriminator` 'ApiSearchAlgorithmDamereau', required
    - `SearchAlgorithmAttributes` ApiSearchAlgorithmAttribute[]: Attributes linked to this algorithm
      - `AttributeId` integer: Linked attribute id
      - `HasPriority` boolean: Indicates priority
      - `UseAutocorrect` boolean: Enables autocorrect for the attribute
    - `SearchAlgorithmId` integer: Unique id of the search algorithm
    - `Sequence` integer: Execution order of the algorithm
    - `Weight` number, double: Weight of the algorithm
    - `StopWhenResultsFound` boolean: Stops when results were found
    - `Enabled` boolean: Indicates whether the search algorithm is enabled
  - object
    - `discriminator` 'ApiSearchAlgorithmCategoryMatch', required
    - `UseSortTemplate` boolean, nullable: Use sort template for this algorithm
    - `UseConjugationsOnCategory` boolean, nullable: Use conjugations on category
    - `UseSynonymsOnCategory` boolean, nullable: Use synonyms on category
    - `SearchAlgorithmExcludedCategories` ApiSearchAlgorithmExcludedCategory[]: Excluded categories linked to this algorithm
      - `CategoryId` integer: Excluded category id
    - `SearchAlgorithmId` integer: Unique id of the search algorithm
    - `Sequence` integer: Execution order of the algorithm
    - `Weight` number, double: Weight of the algorithm
    - `StopWhenResultsFound` boolean: Stops when results were found
    - `Enabled` boolean: Indicates whether the search algorithm is enabled
  - object
    - `discriminator` 'ApiSearchAlgorithmFuzzyV2', required
    - `SearchAlgorithmAttributes` ApiSearchAlgorithmAttribute[]: Attributes linked to this algorithm
      - `AttributeId` integer: Linked attribute id
      - `HasPriority` boolean: Indicates priority
      - `UseAutocorrect` boolean: Enables autocorrect for the attribute
    - `SearchAlgorithmId` integer: Unique id of the search algorithm
    - `Sequence` integer: Execution order of the algorithm
    - `Weight` number, double: Weight of the algorithm
    - `StopWhenResultsFound` boolean: Stops when results were found
    - `Enabled` boolean: Indicates whether the search algorithm is enabled
  - object
    - `discriminator` 'ApiSearchAlgorithmMerchandisingRule', required
    - `SearchAlgorithmId` integer: Unique id of the search algorithm
    - `Sequence` integer: Execution order of the algorithm
    - `Weight` number, double: Weight of the algorithm
    - `StopWhenResultsFound` boolean: Stops when results were found
    - `Enabled` boolean: Indicates whether the search algorithm is enabled
  - object
    - `discriminator` 'ApiSearchAlgorithmPhonetic', required
    - `SearchAlgorithmId` integer: Unique id of the search algorithm
    - `Sequence` integer: Execution order of the algorithm
    - `Weight` number, double: Weight of the algorithm
    - `StopWhenResultsFound` boolean: Stops when results were found
    - `Enabled` boolean: Indicates whether the search algorithm is enabled
  - object
    - `discriminator` 'ApiSearchAlgorithmNumberRecognition', required
    - `AttributeId` integer, nullable: Optional linked attribute id
    - `SearchAlgorithmId` integer: Unique id of the search algorithm
    - `Sequence` integer: Execution order of the algorithm
    - `Weight` number, double: Weight of the algorithm
    - `StopWhenResultsFound` boolean: Stops when results were found
    - `Enabled` boolean: Indicates whether the search algorithm is enabled
  - object
    - `discriminator` 'ApiSearchAlgorithmVectorSearch', required
    - `AttributeId` integer, nullable: Optional linked attribute id
    - `MinimumItemScore` number, double, nullable: Minimum score for resulting items
    - `SearchAlgorithmId` integer: Unique id of the search algorithm
    - `Sequence` integer: Execution order of the algorithm
    - `Weight` number, double: Weight of the algorithm
    - `StopWhenResultsFound` boolean: Stops when results were found
    - `Enabled` boolean: Indicates whether the search algorithm is enabled
  - object
    - `discriminator` 'ApiSearchAlgorithmExactStart', required
    - `AttributeId` integer, nullable: Optional linked attribute id
    - `NumberRecognitionRemoveString` string, nullable: String removed during number recognition
    - `SearchAlgorithmId` integer: Unique id of the search algorithm
    - `Sequence` integer: Execution order of the algorithm
    - `Weight` number, double: Weight of the algorithm
    - `StopWhenResultsFound` boolean: Stops when results were found
    - `Enabled` boolean: Indicates whether the search algorithm is enabled
  - object
    - `discriminator` 'ApiSearchAlgorithmPlugAndPlayVectorSearch', required
    - `MinimumItemScore` number, double, nullable: Minimum score for resulting items
    - `SearchAlgorithmId` integer: Unique id of the search algorithm
    - `Sequence` integer: Execution order of the algorithm
    - `Weight` number, double: Weight of the algorithm
    - `StopWhenResultsFound` boolean: Stops when results were found
    - `Enabled` boolean: Indicates whether the search algorithm is enabled

## Other responses

- `404`: Not Found

---

[API](https://skmtc.dev/tweakwise/apis/app-api.md) - [All operations](https://skmtc.dev/tweakwise/apis/app-api/llms.txt) - [OpenAPI document](https://skmtc.dev/tweakwise/apis/app-api/revisions/dc936bf76941?raw)