Skip to main content
QUERY
helpCenter(id: ID!): HelpCenter

Arguments

id
ID!
required

Returns

id
ID!

Whether this help center is publicly accessible, restricted to specific customers/tenants/tiers, or internal-only.

publicName
String!

The name shown to customers on the help center site.

internalName
String!

The name used to identify this help center within the Plain app (not shown to customers).

description
String

Subdomain and custom domain configuration for this help center.

Settings for the customer support portal embedded in this help center (contact form, thread visibility, etc.).

headCustomJs
String

Custom JavaScript injected into the of every help center page.

bodyCustomJs
String

Custom JavaScript injected at the end of the of every help center page.

isChatEnabled
Boolean!

Whether the live chat widget is enabled on this help center.

articleCopyOptions

Controls which copy-to-clipboard format options (plain text, markdown, ChatGPT, etc.) are shown on article pages.

isCustomerFacingAiEnabled
Boolean!

Whether the AI-powered answer widget is enabled for customers browsing this help center.

agentAvatarImage

Avatar image used to represent the support agent in the AI chat widget on the help center.

color
String
socialPreviewImage

Image used as the Open Graph / social media preview when links to this help center are shared.

Allowlist of tiers, tenants, companies, and customers that can access this help center when type is PRIVATE.

The authentication mechanism used to verify customer identity on a PRIVATE help center.

publishedAt

When this help center was first published (made publicly accessible). Null if never published.

publishedBy
isDeleted
Boolean!

Whether this help center has been soft-deleted.

deletedAt
deletedBy
createdAt
createdBy
updatedAt
updatedBy

All article groups in the help center.

Arguments
first
Int
after
String
last
Int
before
String

All articles in the help center.

Arguments
first
Int
after
String
last
Int
before
String
Query
Variables
Response