---
title: "GET /v1/redirects/"
method: GET
path: "/v1/redirects/"
tags: ["Redirects"]
---

# GET /v1/redirects/

`GET /v1/redirects/`

## Request

- Base URL: `https://api.redirectboss.com`
- URL: `https://api.redirectboss.com/v1/redirects/`
- Auth: API key in header `X-Api-Key`

List all redirects, with optional filtering, search, and pagination.

## Query parameters

- `offset` integer
- `limit` integer
- `orderBy` 'matchType' | 'path' | 'destinationUrl' | 'statusCode' | 'createdAt' | 'updatedAt' | 'host'
- `orderDir` 'ASC' | 'DESC'
- `search` string
- `active` boolean
- `hostId` string, uuid
- `hostName` string, hostname
- `matchType` 'host' | 'exact' | 'prefix'
- `statusCode` 301 | 302 | 303 | 307

## Response `200`

Default Response

- object
  - `data` object[], required
    - `id` string, uuid: Unique redirect identifier
    - `hostId` string, uuid: The host this redirect belongs to
    - `host` string, hostname: The domain name of the associated host
    - `matchType` 'host' | 'exact' | 'prefix': How the redirect matches incoming requests: "host" matches any request to the domain, "exact" matches an exact path, "prefix" matches any path starting with the given prefix
    - `path` string: The path to match (e.g. "/old-page"). Null for "host" match type redirects.
    - `destinationUrl` string: The target URL that matching requests are redirected to
    - `statusCode` 301 | 302 | 303 | 307: The HTTP status code used for the redirect (301=permanent, 302/303/307=temporary)
    - `preserveQueryString` boolean: Whether to forward the original query string to the redirect target
    - `appendPath` boolean: Whether to append the original request path to the redirect target
    - `description` string: Optional note or label for this redirect
    - `active` boolean: Whether the redirect is currently active. Inactive redirects do not process requests but remain fully configured and can be reactivated at any time via PATCH. To permanently remove a redirect, use DELETE instead.
    - `createdAt` string, date-time: When the redirect was created
    - `updatedAt` string, date-time: When the redirect was last updated
  - `meta` object, required
    - `requestId` string: Unique identifier for this request
  - `pagination` object, required
    - `offset` integer: Starting position in the result set
    - `limit` integer: Maximum number of items returned per page
    - `total` integer: Total number of items matching the query
    - `totalPages` integer: Total number of pages available
    - `hasNext` boolean: Whether there is a next page of results
    - `hasPrev` boolean: Whether there is a previous page of results

## Other responses

- `429`: Default Response

---

[API](https://skmtc.dev/redirectboss/apis/redirectboss-api.md) · [All operations](https://skmtc.dev/redirectboss/apis/redirectboss-api/llms.txt) · [OpenAPI document](https://skmtc.dev/redirectboss/apis/redirectboss-api/revisions/0159ad2b68fa?raw)