Retrieve a redirect

Request

You can fetch the details of a single redirect by making a GET request to https://api.intercom.io/help_center/help_centers/{help_center_id}/redirects/{id}.

Requires the read_help_center_redirects_scope OAuth scope.

Security

bearerAuth

Path

help_center_idstringrequired

The unique identifier for the help center.

Example:123

idstringrequired

The unique identifier for the redirect.

Example:26

Intercom-Versionstring(intercom_version)

Intercom API version.
If you omit the header, the API uses the version set in your app package, and 1.0 if none is set.

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example:2.17

curl -i -X GET \
  https://api.intercom.io/help_center/help_centers/123/redirects/26 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.17'

Responses

Successful

Bodyapplication/json

idstring

The unique identifier for the redirect.

Example:"26"

typestring

The type of the object - help_center_redirect.

Value:"help_center_redirect"

Example:"help_center_redirect"

from_urlstring

The source URL that is redirected. This is an absolute URL within the help center's URL space, or a relative path such as /old-page for some existing redirects.

Example:"http://help-center.test/lovelyhelpcenter/old-page"

localestring

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.

Example:"en"

help_center_idstring

The unique identifier for the help center the redirect belongs to.

Example:"7"

target_typestring

The type of the redirect target.

Enum:"article""collection"

Example:"article"

target_idstring

The unique identifier of the target article or collection. For article targets this is the Article ID.

Example:"11"

created_atinteger

The time the redirect was created as a UTC Unix timestamp.

Example:1781619405

updated_atinteger

The time the redirect was last updated as a UTC Unix timestamp.

Example:1781619405

Response

{
  "id": "26",
  "type": "help_center_redirect",
  "from_url": "http://help-center.test/lovelyhelpcenter/old-page",
  "locale": "en",
  "help_center_id": "7",
  "target_type": "article",
  "target_id": "11",
  "created_at": 1781619405,
  "updated_at": 1781619405
}