List all URL redirect rules configured for a site

Returns a paginated list of redirect rules for the site. Supports filtering by draft status and searching by path. Use this to audit redirects, find a specific rule before updating it, or check whether draft redirects are pending publication.

Available in MCP

get

Authorizations

useroauth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

siteIdstringRequired

The unique id of the site

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

searchstringOptional

Search for a redirect by path

draftbooleanOptional

Filter redirects by draft mode.

Default: false

Responses

200

The list of redirects for the site.

application/json

countnumberOptional

Total count of objects in the list

get/orgs/{organizationId}/sites/{siteId}/redirects

HTTPcURLJavaScriptPython

GET /v1/orgs/{organizationId}/sites/{siteId}/redirects HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

The list of redirects for the site.

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "site-redirect",
      "id": "text",
      "source": "text",
      "draft": true,
      "captureWildcard": true,
      "destination": {
        "kind": "site-section",
        "siteSectionId": "text"
      }
    }
  ]
}