GET/desk/api/v2/helpdocssites/helpdocarticles.json
Get a paginated list of helpdocarticles.
The following values are allowed in the filter query parameter:
- contents
- createdAt
- createdBy
- deletedAt
- deletedBy
- description
- displayOrder
- disqusEnabled
- editMethod
- id
- isPrivate
- oldURL
- popularity
- siteId
- slug
- state
- status
- title
- updatedAt
- updatedBy
The following values are allowed in the orderBy query parameter:
-
contents
-
createdAt
-
createdBy
-
deletedAt
-
deletedBy
-
description
-
displayOrder
-
disqusEnabled
-
editMethod
-
id
-
isPrivate
-
oldURL
-
popularity
-
siteId
-
slug
-
state
-
status
-
status
-
title
-
title
-
updatedAt
-
updatedAt
-
updatedBy
The following values are allowed in the [includes](https://apidocs.teamwork.com/guides/desk/relationships-and-includes) query parameter: -
sites
-
users
-
all
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-12-19T16:02:34.120Z", "createdBy": { "delete": true, "id": 0, "meta": { "additionalProp": "Unknown Type: any" }, "type": 0 }, "deletedAt": "2024-12-19T16:02:34.120Z", "deletedBy": {