GET/desk/api/v2/helpdocssites.json
Get a paginated list of helpdocssites.
The following values are allowed in the filter query parameter:
- articleTemplate
- authenticationType
- authenticationTypeId
- categoryTemplate
- contactFormEnabled
- createdAt
- createdBy
- customDomain
- customStyleSheet
- description
- disqusShortname
- editMethod
- favicon
- footerTemplate
- headTemplate
- headerBGColor
- homePageLinkEnabled
- homePageLinkText
- homePageURL
- homeTemplate
- htmlHeadCode
- id
- languageCode
- linkColor
- logoImage
- metaSiteDescription
- name
- navActiveColor
- navTextColor
- pageBGColor
- password
- publicSiteEnabled
- searchTemplate
- sendEmailsToInboxId
- showDateLastModified
- showOnHomePage
- showSocialIcons
- state
- subdomain
- textColor
- touchIcon
- updatedAt
- updatedBy
The following values are allowed in the orderBy query parameter:
-
articleTemplate
-
authenticationType
-
authenticationTypeId
-
categoryTemplate
-
contactFormEnabled
-
createdAt
-
createdBy
-
customDomain
-
customStyleSheet
-
description
-
disqusShortname
-
editMethod
-
favicon
-
footerTemplate
-
headTemplate
-
headerBGColor
-
homePageLinkEnabled
-
homePageLinkText
-
homePageURL
-
homeTemplate
-
htmlHeadCode
-
id
-
languageCode
-
linkColor
-
logoImage
-
metaSiteDescription
-
name
-
name
-
navActiveColor
-
navTextColor
-
pageBGColor
-
password
-
publicSiteEnabled
-
searchTemplate
-
sendEmailsToInboxId
-
showDateLastModified
-
showOnHomePage
-
showSocialIcons
-
state
-
subdomain
-
subdomain
-
textColor
-
touchIcon
-
updatedAt
-
updatedBy
The following values are allowed in the [includes](https://apidocs.teamwork.com/guides/desk/relationships-and-includes) query parameter: -
helpdoctemplates
-
users
-
all
Responses
- Code
- 200
- Type
- object
- Schema
- Description
- 200 OK
- 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
HelpdocsSitesAPIBody
{ "helpdocssites": [ { "articleTemplate": "string", "authenticationType": "string", "authenticationTypeId": 0, "categoryTemplate": "string", "contactFormEnabled": true, "contributors": [ { "delete": true, "id": 0, "meta": { "additionalProp": "Unknown Type: any" }, "type": 0 } ],