GET/desk/api/v2/helpdocssites/{siteId}/helpdocarticles/{id}.json

Get a single helpdocarticle by id.

The following values are allowed in the includes query parameter:

  • sites
  • users
  • all

Path Params

  • Name
    siteId
    Type
    integer
    required
    Description
  • Name
    id
    Type
    integer
    required
    Description

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    HelpdocArticleAPIBody handles the request/response for a single helpdoc article
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.

Examples

200 OK

HelpdocArticleAPIBody
{  "helpdocarticle": {    "categories": [      0    ],    "contents": "string",    "createdAt": "2024-10-10T18:19:26.131Z",    "createdBy": {      "delete": true,      "id": 0,      "meta": {        "additionalProp": "Unknown Type: any"      },      "type": 0    },    "deletedAt": "2024-10-10T18:19:26.131Z",    "deletedBy": {      "delete": true,
Download Swagger