---
title: "Retrieve redirect rules"
method: GET
path: "/v1/redirect_rules"
tags: ["Redirect rules"]
---

# Retrieve redirect rules

`GET /v1/redirect_rules`

**🔐 This endpoint requires [HTTP authentication](https://docs.constructor.com/reference/main-authentication) (either [Basic](https://docs.constructor.com/reference/main-authentication#basic-authentication) or [Bearer](https://docs.constructor.com/reference/main-authentication#bearer-authentication)).**
For authenticating with Bearer token, required scopes are: `redirects(r)`.

Retrieve all redirect rules

## Query parameters

- `key` string, required — The key of the index to use.
- `id` union — The ID(s) of redirect rules to filter by.
  - integer
  - integer[]
- `query` string — A search query for redirect rules.
- `num_results_per_page` integer — The number of results per page to return.
- `page` integer — The page of results to return.
- `offset` integer — The number of results to skip from the beginning. Cannot be used together with `page`.
- `sort_order` 'ascending' | 'descending'
- `status` 'current' | 'pending' | 'expired' — A filter by status of redirect rules.
- `c` string — The ID of the client and version that the request is coming from, such as `cio-js-2.90`.

## Response `200`

OK

- RedirectRuleListGetResponse
  - `redirect_rules` RedirectRule[], required — A list of redirect rules.
    - `id` integer, required — The identifier for the redirect rule match.
    - `start_time` string, date-time — The start time for the redirect rule.
    - `end_time` string, date-time — The end time for the redirect rule.
    - `url` string, required — The target URL for redirect the rule.
    - `metadata` object — The metadata for the redirect rule.
    - `last_updated` string, date-time — The last updated time for the redirect rule.
    - `user_segments` string[] — A list of user segments for the redirect rule.
    - `matches` RedirectRuleMatchResponse[], required — A list of redirect rule matches.
      - `pattern` string, required — The pattern for the redirect rule match.
      - `match_type` 'EXACT' | 'PHRASE' | 'UNORDERED', required — The match type for the redirect rule.
      - `id` integer, required — The identifier for the redirect rule match.
  - `total_count` integer, required — The total count of redirect rules.

## Other responses

- `400` — Validation Error
- `401` — Credentials are not passed or action is forbidden.
- `403` — The supplied token does not have the required permissions.
- `429` — Rate limit breached

---

[API](https://skmtc.dev/constructor/apis/autocomplete.md) · [All operations](https://skmtc.dev/constructor/apis/autocomplete/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/constructor/autocomplete/revisions/2d33330633b6/schema)