Support

Retrieve a knowledge base article.

get/api/v1/support/articles/{articleUid}

Request

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

Path parameters

articleUidstring nullable required

The article's unique identifier

Response

Uidstring nullable
_objectTypestring nullable
Createdstring date-time required
Updatedstring date-time required
ActivityEventDataunknown
Weightinteger
Titlestring nullable
Bodystring nullable
SupportArticleStatus1 | 2 | 3

1 - Draft, 2 - WaitingReview, 3 - Published

Keywordsstring nullable

Example response

{
  "Uid": "string",
  "_objectType": "string",
  "Created": "string",
  "Updated": "string",
  "ActivityEventData": {},
  "Weight": 0,
  "Title": "string",
  "Body": "string",
  "SupportArticleStatus": 1,
  "Category": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "Name": "string",
    "Description": "string",
    "Weight": 0,
    "Articles": []
  },
  "Keywords": "string",
  "Tags": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "Name": "string",
      "SystemName": "string",
      "SystemDescription": "string",
      "TagColor": 1,
      "EntityType": 0
    }
  ]
}

Changes

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