GET/desk/api/v2/helpdocssites.json
Get a paginated list of helpdocssites.
The following values are allowed in the filter query parameter:
- id
- name
- description
- metaSiteDescription
- subdomain
- contactFormEnabled
- showDateLastModified
- customDomain
- customStyleSheet
- homePageLinkEnabled
- homePageLinkText
- homePageURL
- htmlHeadCode
- logoImage
- favicon
- touchIcon
- publicSiteEnabled
- sendEmailsToInboxId
- showOnHomePage
- headerBGColor
- navActiveColor
- navTextColor
- pageBGColor
- linkColor
- textColor
- languageCode
- password
- showSocialIcons
- disqusShortname
- authenticationType
- authenticationTypeId
- editMethod
- searchTemplate
- homeTemplate
- headTemplate
- footerTemplate
- categoryTemplate
- articleTemplate
- createdAt
- updatedAt
- createdBy
- updatedBy
- state
The following values are allowed in the orderBy query parameter:
- id
- name
- description
- metaSiteDescription
- subdomain
- contactFormEnabled
- showDateLastModified
- customDomain
- customStyleSheet
- homePageLinkEnabled
- homePageLinkText
- homePageURL
- htmlHeadCode
- logoImage
- favicon
- touchIcon
- publicSiteEnabled
- sendEmailsToInboxId
- showOnHomePage
- headerBGColor
- navActiveColor
- navTextColor
- pageBGColor
- linkColor
- textColor
- languageCode
- password
- showSocialIcons
- disqusShortname
- authenticationType
- authenticationTypeId
- editMethod
- searchTemplate
- homeTemplate
- headTemplate
- footerTemplate
- categoryTemplate
- articleTemplate
- createdAt
- updatedAt
- createdBy
- updatedBy
- state
- name
- subdomain
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 } ],