helpCenterArticle

QUERY

helpCenterArticle(id: ID!): HelpCenterArticle

Arguments

ID!

required

Returns

HelpCenterArticle

ID!

title

String!

description

String

Short summary of the article shown in search results and navigation previews.

icon

String

Opaque icon key that identifies the decorative icon displayed alongside the article title.

contentHtml

String!

Full article body as HTML. This is rendered directly in the help center.

slug

String!

URL-safe identifier for the article, unique within the help center. Normalized to lowercase.

status

HelpCenterArticleStatus!

Whether the article is publicly visible (PUBLISHED) or only visible inside the Plain app (DRAFT).

statusChangedAt

DateTime!

When the article's status was last changed.

statusChangedBy

createdAt

createdBy

updatedAt

updatedBy

helpCenter

The help center this article belongs to.

articleGroup

HelpCenterArticleGroup

The group this article belongs to, if any.

labelTypes

[LabelType!]!

Label types associated with this article, used to scope AI retrieval to specific topics.

Query

query HelpCenterArticle($id: ID!) {
  helpCenterArticle(id: $id) {
    id
    title
    description
    icon
    contentHtml
    slug
  }
}

Variables

{
  "id": "id"
}

Response

{
  "data": {
    "helpCenterArticle": {
      "id": "id",
      "title": "string",
      "description": "string",
      "icon": "string",
      "contentHtml": "string",
      "slug": "string"
    }
  }
}

⌘I

Query

query HelpCenterArticle($id: ID!) {
  helpCenterArticle(id: $id) {
    id
    title
    description
    icon
    contentHtml
    slug
  }
}

Variables

{
  "id": "id"
}

Response

{
  "data": {
    "helpCenterArticle": {
      "id": "id",
      "title": "string",
      "description": "string",
      "icon": "string",
      "contentHtml": "string",
      "slug": "string"
    }
  }
}

Queries

Mutations

Types

Arguments

Returns