Support

Retrieve all knowledge base articles.

get/api/v1/support/articles

Request

  • Base URL: https://go.outseta.com
  • URL: https://go.outseta.com/api/v1/support/articles
  • Auth: none declared

Query parameters

qstring nullable

Matches on title or body of the article

tagUidstring

Keep only the records that carry one of these tags. Separate several tag uids with commas. The value none keeps the records that carry no tag at all.

withoutTagUidstring

Keep only the records that carry none of these tags. Separate several tag uids with commas. Combined with tagUid, the two widen the result instead of narrowing it: a record is kept when it matches either one.

limitinteger

Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.

offsetinteger

Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).

Response

Example response

{
  "metadata": {
    "limit": 0,
    "offset": 0,
    "total": 0
  },
  "items": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "Weight": 0,
      "Title": "string",
      "Body": "string",
      "SupportArticleStatus": 1,
      "Category": {},
      "Keywords": "string",
      "Tags": []
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.