Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.plain.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Using TypeScript? Check out our GraphQL SDK for a fully typed client.

​
List help centers

Query
query getHelpCenters($first: Int = 50, $after: String) {
  helpCenters(first: $first, after: $after) {
    edges {
      node {
        id
        type
        publicName
        internalName
        domainSettings {
          domainName
          customDomainName
        }
        isDeleted
        publishedAt {
          iso8601
        }
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}
Variables
{
  "first": 50
}

​
Get a help center by ID

Query
query getHelpCenter($id: ID!) {
  helpCenter(id: $id) {
    id
    type
    publicName
    internalName
    description
    domainSettings {
      domainName
      customDomainName
      customDomainNameVerifiedAt {
        iso8601
      }
    }
    isChatEnabled
    publishedAt {
      iso8601
    }
  }
}
Variables
{
  "id": "hc_01HXXXXXXXXXXXXXXXXXXXXXXX"
}

​
Get a help center article by ID

Query
query getHelpCenterArticle($id: ID!) {
  helpCenterArticle(id: $id) {
    id
    title
    description
    icon
    contentHtml
    slug
    status
    articleGroup {
      id
      name
      slug
    }
  }
}
Variables
{
  "id": "hca_01HXXXXXXXXXXXXXXXXXXXXXXX"
}

​
Get a help center article by slug

slug is unique within a help center.
Query
query getHelpCenterArticleBySlug($helpCenterId: ID!, $slug: String!) {
  helpCenterArticleBySlug(helpCenterId: $helpCenterId, slug: $slug) {
    id
    title
    description
    contentHtml
    slug
    status
  }
}
Variables
{
  "helpCenterId": "hc_01HXXXXXXXXXXXXXXXXXXXXXXX",
  "slug": "getting-started"
}