---
title: "Returns all redirects"
method: GET
path: "/redirect"
tags: ["Redirect"]
---

# Returns all redirects

`GET /redirect`

## Request

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

## Query parameters

- `limit` integer
- `offset` integer
- `searchTerm` string
- `categoryId` integer
- `types` RedirectTypeApiModel[]

## Response `200`

OK

- RedirectApiModels: Paginated collection of redirects
  - `Total` integer, nullable, required: The total number of records which can be retrieved. Note that this field is not available for all paginated endpoints.
  - `Records` RedirectApiModel[], required: The retrieved records.
    - `Id` integer: Id of the redirect
    - `Type` 'Keyword' | 'Attribute'
    - `AttributeId` integer, nullable: Attribute linked to the redirect
    - `CategoryId` integer, nullable: Category linked to the redirect
    - `Url` string, nullable: The redirect URL
    - `Exclusions` string, nullable: Exclusions for the redirect
    - `UseConjugations` boolean: Indicates whether conjugations are used
    - `UseCustomConjugations` boolean: Indicates whether custom conjugations are used
    - `Terms` string[], nullable: Terms that trigger this redirect. Used for type keyword redirect
    - `Conjugations` string[], nullable: Conjugations for the terms. Used for type keyword redirect
    - `Replacements` RedirectReplacementApiModel[], nullable: Attribute value replacements. Used for type attribute redirect
      - `Sequence` integer: Sequence order of the replacement
      - `OriginalValue` string, nullable: Original value to replace
      - `ReplacementValue` string, nullable: Value to replace the original with

## Other responses

- `400`: Bad Request

---

[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)