gainsight-px-rest-api
GET /v1/articles

Fetch metadata for Articles from your PX Subscription. The API provides you with the summary of basic information of each article that makes it easy to work with specific data.

Examples:

URI Results
GET /v1/articles?pageSize=100 Get first 100 articles.
GET /v1/articles?pageSize=100&pageNumber=1 Get next 100 articles.
GET /v1/articles?productId=1234LPSWUBFW Get Articles of product 1234LPSWUBFW.

Important: The default pageSize on list calls is 200. The pageSize can be changed by adding a pageSize parameter to the URL (i.e. /v1/articles?pageSize=100) with a max pageSize=500.

To fetch a particular page, use the pageNumber parameter (zero based)

Query parameters

  • pageNumber integer(int32)

    Page number

    Default value is 0.

  • pageSize integer(int32)

    Number of events per page range[1,500]

    Default value is 200.

  • productId string

    Property Group

Responses

  • 200 application/json

    Success

    Hide response attributes Show response attributes object
    • articleExternalViewList array[object]

      Array of Articles View

      Hide articleExternalViewList attributes Show articleExternalViewList attributes object
      • articleKCs array[object]
        Hide articleKCs attributes Show articleKCs attributes object
        • kcId string
        • kcName string
      • articleName string
      • author string
      • createdDate integer(int64)
      • defaultLanguage string
      • id string
      • languages array[object]
        Hide languages attributes Show languages attributes object
        • languageCode string
        • translated boolean
      • modifiedBy object
        Hide modifiedBy attributes Show modifiedBy attributes object
        • id string
        • name string
      • modifiedDate integer(int64)
      • productId string
      • productName string
      • releaseDate string(date-time)
      • translationState string
      • viewType string
    • pageNumber integer(int32)

      Page number

    • isLastPage boolean

      True if no more records available on next page
  • 400

    Bad request

  • 401

    Unauthorized or bad API Key

  • 429

    Rate limit exceeded

GET /v1/articles 
curl \
 --request GET 'https://api.aptrinsic.com/v1/articles'
Response examples (200) 
{
  "articleExternalViewList": [
    {
      "articleKCs": [
        {
          "kcId": "string",
          "kcName": "string"
        }
      ],
      "articleName": "string",
      "author": "string",
      "createdDate": 42,
      "defaultLanguage": "string",
      "id": "string",
      "languages": [
        {
          "languageCode": "string",
          "translated": true
        }
      ],
      "modifiedBy": {
        "id": "string",
        "name": "string"
      },
      "modifiedDate": 42,
      "productId": "string",
      "productName": "string",
      "releaseDate": "2026-05-04T09:42:00Z",
      "translationState": "string",
      "viewType": "string"
    }
  ],
  "pageNumber": 42,
  "isLastPage": true
}