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

List redirects for a help center

Lists URL redirects configured for a help center, ordered by most recently updated. Use the pagination parameters to browse the results; access requires the read_help_center_redirects_scope OAuth scope.

4 parameters
help_center_idstringrequired
The unique identifier of the help center whose redirects to list.
pageintegeroptional
The page of results to fetch. Defaults to the first page when omitted.
per_pageintegeroptional
The number of results to return per page. Defaults to 50 when omitted and accepts a maximum of 250.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted; use a supported version.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

3 status codes
200Returns a list of help center redirect objects, a total count, and pagination details. Redirects are ordered by `updated_at` descending.
typestringoptional
The type of the object - `list`.
Allowed:list
pagesobjectoptional
Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.
total_countintegeroptional
A count of the total number of redirects.
dataarray<HelpCenterRedirect>optional
An array of help center redirect objects.
401Returned when the request is unauthorized or the required `read_help_center_redirects_scope` OAuth scope is missing.

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 specified help center 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 or lacks the required read_help_center_redirects_scope OAuth scope. A 404 is returned when the help center identified by the help_center_id path parameter is not found. The per_page query parameter accepts a maximum of 250 results per page.