Skip to main content
Help Centers

List redirect rules

Returns a paginated list of redirect rules within your organization.

GET
/v2/help_center/redirect_rules

Redirect rules map old Help Center URLs to new article or collection destinations, enabling seamless migration from legacy help center systems. Only Help Centers with a custom domain configured support redirect rules.

Query Parameters

  • limit - Number of items to return (1-100, default 10)
  • cursor - Cursor for pagination
  • helpCenterId - Filter by help center ID
  • locale - Filter by locale code
  • targetType - Filter by target type ("article" or "collection")

Response Format

Returns a list object with:

  • object - Always "list"
  • data - Array of redirect rule objects
  • nextCursor - Cursor for next page (null if no more results)

Redirect Rule Object

Each redirect rule includes:

  • id - Unique identifier (MongoDB ObjectId)
  • helpCenterId - Help center this rule belongs to
  • locale - Locale code used to resolve the target translation
  • fromUrl - Canonical source URL (query/hash stripped, hostname lowercased)
  • 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

Authorizations

Authorizationstringheaderrequired

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

Query Parameters

limitintegerquerydefault:10

A limit on the number of objects to be returned, between 1 and 100.

Required range: 1 <= x <= 100
Example: 10
cursorstringquery

An opaque cursor for pagination. Use the nextCursor value from a previous response to fetch the next page.

Maximum string length: 512
Example: eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9
helpCenterIdstringquery

Filter redirect rules by help center ID

Required string length: 1 - 16
Pattern: ^[a-zA-Z0-9]+$
Example: ox6qrqprmsuqaunj
localeenum<string>query

Filter redirect rules by locale

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
targetTypeenum<string>query

Filter redirect rules by target type

Available options: article, collection
Example: article

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

dataobject[]required

Array of redirect rules

nextCursorstring | nullrequired

Cursor for fetching the next page. Null if there are no more results.

objectenum<string>required

Object type identifier

Available options: list
Example: list

Still need help? Ask the team