Intercom API (unofficial showcase)
GET/help_center/help_centers/{help_center_id}/redirects/{id}

Retrieve a help center redirect

Retrieves a redirect from a specific help center. Use the help center and redirect identifiers to fetch the redirect's source URL, locale, and target details. Access requires the read_help_center_redirects_scope OAuth scope.

3 parameters
help_center_idstringrequired
The unique identifier of the help center containing the redirect.
idstringrequired
The unique identifier of the redirect to retrieve.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted; listed supported values include 1.0 through 1.4 and 2.0 through 2.6.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

3 status codes
200Returns the redirect, including its identifier, source URL, locale, target details, help center identifier, and creation and update timestamps.
idstringoptional
The unique identifier for the redirect.
typestringoptional
The type of the object - `help_center_redirect`.
Allowed:help_center_redirect
from_urlstringoptional
The source URL that is redirected. An absolute URL within the help center's URL space.
localestringoptional
The locale of the redirect's target. For article targets this is the bound translation's locale, which may differ from the requested locale if no translation exists in that locale.
help_center_idstringoptional
The unique identifier for the help center the redirect belongs to.
target_typestringoptional
The type of the redirect target.
Allowed:articlecollection
target_idstringoptional
The unique identifier of the target article or collection. For article targets this is the Article ID.
created_atintegeroptional
The time the redirect was created as a UTC Unix timestamp.
updated_atintegeroptional
The time the redirect was last updated as a UTC Unix timestamp.
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the help center or redirect is not found.

One documented failure

  • not_found

    Resource not found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized, and a 404 is returned when the help center or redirect is not found. The help_center_id path parameter must identify the help center, and the id path parameter must identify a redirect in that help center. Access requires the read_help_center_redirects_scope OAuth scope.