Fetch help centers and articles

Fetch help centers, and fetch articles by slug or ID.

You can fetch help centers as a collection or by ID, and fetch an individual article by either its ID or its slug.

For TypeScript, the GraphQL SDK gives you a fully typed client for these operations.

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"
}