Help center articles

Get a help center article by id. Pass format=html or format=markdown to additionally include the article content converted to that format (as a localized contentHtml / contentMarkdown field) next to the stored editor JSON. Omit the parameter to return the article unchanged.

get/helpcenter/collections/{helpcenterCollectionId}/articles/{helpcenterArticleId}

Request

  • Base URL
    https://api.gleap.io/v3
  • URL
    https://api.gleap.io/v3/helpcenter/collections/{helpcenterCollectionId}/articles/{helpcenterArticleId}
  • Auth
    HTTP bearer

Path parameters

helpcenterArticleIdstring required

Query parameters

formatstring

Response

Ok

unknown required

Changes

    • info

      added the new optional query request parameter format

    • info

      removed from the response body allOf list for the response status