Skip to main content
GET
/
helpcenter
/
collections
/
{helpcenterCollectionId}
/
articles
Get all articles
curl --request GET \
  --url https://api.gleap.io/v3/helpcenter/collections/{helpcenterCollectionId}/articles \
  --header 'Authorization: Bearer <token>' \
  --header 'project: <project>'
[
  {
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "sourceUsage": 123,
    "isDraft": true,
    "tags": [
      "<string>"
    ],
    "targetAudience": "<string>",
    "extendedAudienceFilter": "<unknown>",
    "baseAudienceFilter": "<unknown>",
    "externalId": "<string>",
    "docId": 123,
    "author": {
      "isValid": {},
      "createFromHexString": {},
      "createFromTime": {},
      "generate": {},
      "cacheHexString": "<unknown>"
    },
    "helpcenterCollection": {
      "isValid": {},
      "createFromHexString": {},
      "createFromTime": {},
      "generate": {},
      "cacheHexString": "<unknown>"
    },
    "upvotes": "<unknown>",
    "plainContent": "<unknown>",
    "lexorank": "<string>",
    "project": {
      "isValid": {},
      "createFromHexString": {},
      "createFromTime": {},
      "generate": {},
      "cacheHexString": "<unknown>"
    },
    "content": "<unknown>",
    "title": "<unknown>",
    "description": "<unknown>"
  }
]

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

project
string
required

Response

200 - application/json

Ok

updatedAt
string
required
createdAt
string
required
sourceUsage
number<double>
required
isDraft
boolean
required
tags
string[]
required
targetAudience
string
required
extendedAudienceFilter
any
baseAudienceFilter
any
externalId
string
docId
number<double>
author
object
helpcenterCollection
object
upvotes
any
plainContent
any
lexorank
string
project
object
content
any
title
any
description
any