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

Retrieve a help center

Retrieves details for a help center. Provide its identifier to inspect its URL, display name, availability, and configured locales. Use this operation to view the help center's workspace and configuration details.

2 parameters
help_center_idintegerrequired
The unique integer identifier of the help center 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 help center, including its identifier, workspace, timestamps, URL, display name, custom domain, default status, availability, and locales.
idstringoptional
The unique identifier for the Help Center which is given by Intercom.
workspace_idstringoptional
The id of the workspace which the Help Center belongs to.
created_atintegeroptional
The time when the Help Center was created.
updated_atintegeroptional
The time when the Help Center was last updated.
identifierstringoptional
The identifier of the Help Center. This is used in the URL of the Help Center.
website_turned_onbooleanoptional
Whether the Help Center is turned on or not. This is controlled in your Help Center settings.
display_namestringoptional
The display name of the Help Center only seen by teammates.
urlstringoptional
The URL for the help center, if you have a custom domain then this will show the URL using the custom domain.
custom_domainstringoptional
Custom domain configured for the help center
defaultbooleanoptional
Whether this help center is the default for the workspace.
localesarray<string>optional
The locales in which the help center is available.
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 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 is not found. The help_center_id path parameter must identify an existing help center.