Skip to main content
Help Centers

Get a redirect rule by URL

Retrieves a specific redirect rule by its source URL.

GET
/v2/help_center/redirect_rules/by-url

The url query parameter is normalized before matching: query parameters and hash fragments are stripped, the hostname is lowercased, and trailing slashes are removed. This is the same normalization applied when creating a redirect rule.

Query Parameters

  • url (required) - Full absolute URL to look up (http or https)

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

  • 400 - Invalid URL format
  • 404 - No redirect rule exists for the given URL

Authorizations

Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Query Parameters

urlstringqueryrequired

Full absolute URL to look up. The URL is normalized before matching: query parameters and hash fragments are stripped, the hostname is lowercased, and trailing slashes are removed.

Maximum string length: 2048
Example: https://help.example.com/en/old/getting-started

Headers

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover
Example: 2026-08-19.orbit

Response

application/json

Success

createdAtstringrequired

ISO 8601 timestamp when created

Example: 2026-02-11T12:00:00.000Z
fromUrlstringrequired

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

Example: https://help.example.com/en/old/getting-started
helpCenterIdstringrequired

Help center identifier

Example: ox6qrqprmsuqaunj
idstringrequired

Redirect rule unique identifier

Example: 507f1f77bcf86cd799439011
localeenum<string>required

Locale code for the redirect rule

Available options: ar, am, fa, ht, lo, my, pa, ps, so, tl, ur, he, ta, te, mr, gu, kn, ml, ha, jv, yo, ig, uz, ne, sd, az, si, km, kk, 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
Example: en
objectenum<string>required

Object type identifier

Available options: redirect_rule
Example: redirect_rule
targetIdstringrequired

Target article or collection ID

Example: 1234567
targetTypeenum<string>required

Type of content the redirect points to

Available options: article, collection
Example: article
updatedAtstringrequired

ISO 8601 timestamp when last updated

Example: 2026-02-11T12:00:00.000Z

Still need help? Ask the team