Skip to content
Home/
REST API Reference
/
/
Help Center

Help Center

Help Centers contain collections

idstring

The unique identifier for the Help Center which is given by Intercom.

Example:"123"
workspace_idstring

The id of the workspace which the Help Center belongs to.

Example:"hfi1bx4l"
created_atinteger, (date-time)

The time when the Help Center was created.

Example:1672928359
updated_atinteger, (date-time)

The time when the Help Center was last updated.

Example:1672928610
identifierstring

The identifier of the Help Center. This is used in the URL of the Help Center.

Example:"intercom"
website_turned_onboolean

Whether the Help Center is turned on or not. This is controlled in your Help Center settings.

Example:true
display_namestring

The display name of the Help Center only seen by teammates.

Example:"Intercom Help Center"
urlstring

The URL for the help center, if you have a custom domain then this will show the URL using the custom domain.

Example:"https://help.mycompany.com"
custom_domainstring or null

Custom domain configured for the help center

Example:"help.mycompany.com"
defaultboolean

Whether this help center is the default for the workspace.

Example:false
localesArray of strings

The locales in which the help center is available.

Example:
[
  "en",
  "fr"
]
{
  "id": "123",
  "workspace_id": "hfi1bx4l",
  "created_at": 1672928359,
  "updated_at": 1672928610,
  "identifier": "intercom",
  "website_turned_on": true,
  "display_name": "Intercom Help Center",
  "url": "https://help.mycompany.com",
  "custom_domain": "help.mycompany.com",
  "default": false,
  "locales": [
    "en",
    "fr"
  ]
}