Get a redirect rule by ID

GET/v2/help_center/redirect_rules/{id}

Retrieves a specific redirect rule by its unique identifier.

Returns the redirect rule object if found in your organization.

Response

Returns a redirect rule object with:

id - Unique identifier (MongoDB ObjectId)
helpCenterId - Help center this rule belongs to
locale - Locale code
fromUrl - Canonical source URL being redirected from
targetType - “article” or “collection”
targetId - ID of the target article or collection
createdAt - ISO 8601 timestamp when created
updatedAt - ISO 8601 timestamp when last updated

Errors

404 - Redirect rule not found in your organization

Path ParametersExpand Collapse

id: string

Redirect rule unique identifier

Header ParametersExpand Collapse

"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"

One of the following:

"2026-01-01.nova"

"2025-12-12.clover"

ReturnsExpand Collapse

RedirectRule object { id, createdAt, fromUrl, 6 more }

id: string

Redirect rule unique identifier

createdAt: string

ISO 8601 timestamp when created

fromUrl: string

Canonical source URL being redirected from (query and hash stripped)

helpCenterId: string

Help center identifier

locale: "bn" or "bs" or "pt-BR" or 39 more

Locale code for the redirect rule

One of the following:

"bn"

"bs"

"pt-BR"

"bg"

"ca"

"hr"

"cs"

"da"

"nl"

"en"

"et"

"fi"

"fr"

"de"

"el"

"hi"

"hu"

"id"

"it"

"ja"

"ko"

"lv"

"lt"

"ms"

"mn"

"nb"

"pl"

"pt"

"ro"

"ru"

"sr"

"zh-CN"

"sk"

"sl"

"es"

"sw"

"sv"

"th"

"zh-TW"

"tr"

"uk"

"vi"

object: "redirect_rule"

Object type identifier

targetId: string

Target article or collection ID

targetType: "article" or "collection"

Type of content the redirect points to

One of the following:

"article"

"collection"

updatedAt: string

ISO 8601 timestamp when last updated

Get a redirect rule by ID

curl https://do.featurebase.app/v2/help_center/redirect_rules/$ID \
    -H "Authorization: Bearer $FEATUREBASE_API_KEY"

{
  "id": "507f1f77bcf86cd799439011",
  "createdAt": "2026-02-11T12:00:00.000Z",
  "fromUrl": "https://help.example.com/en/old/getting-started",
  "helpCenterId": "ox6qrqprmsuqaunj",
  "locale": "en",
  "object": "redirect_rule",
  "targetId": "1234567",
  "targetType": "article",
  "updatedAt": "2026-02-11T12:00:00.000Z"
}

Returns Examples

{
  "id": "507f1f77bcf86cd799439011",
  "createdAt": "2026-02-11T12:00:00.000Z",
  "fromUrl": "https://help.example.com/en/old/getting-started",
  "helpCenterId": "ox6qrqprmsuqaunj",
  "locale": "en",
  "object": "redirect_rule",
  "targetId": "1234567",
  "targetType": "article",
  "updatedAt": "2026-02-11T12:00:00.000Z"
}