GET/desk/api/v2/helpdocssites/helpdocarticles.json
Get a paginated list of helpdocarticles.
The following values are allowed in the filter query parameter:
- id
- siteId
- title
- slug
- description
- oldURL
- popularity
- disqusEnabled
- isPrivate
- editMethod
- displayOrder
- status
- contents
- createdAt
- updatedAt
- deletedAt
- createdBy
- updatedBy
- deletedBy
- state
The following values are allowed in the orderBy query parameter:
- id
- siteId
- title
- slug
- description
- oldURL
- popularity
- disqusEnabled
- isPrivate
- editMethod
- displayOrder
- status
- contents
- createdAt
- updatedAt
- deletedAt
- createdBy
- updatedBy
- deletedBy
- state
- title
- updatedAt
- status
Responses
- Code
- 200
- Type
- object
- Schema
- Description
- 200 OK
HelpdocArticlesAPIBody handles the request/response for helpdoc article listing
- 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.
200 OK
HelpdocArticlesAPIBody
{ "helpdocarticles": [ { "categories": [ 0 ], "contents": "string", "createdAt": "2024-09-13T11:17:24.961Z", "createdBy": { "delete": true, "id": 0, "meta": { "additionalProp": "Unknown Type: any" }, "type": 0 }, "deletedAt": "2024-09-13T11:17:24.961Z", "deletedBy": {