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": {},
"type": 0
}
],
"createdAt": "2024-07-26T20:26:10.533Z",
"createdBy": {
"delete": true,
"id": 0,
"meta": {},
"type": 0
},
"customDomain": "string",
"customStyleSheet": "string",
"deletedAt": "2024-07-26T20:26:10.533Z",
"deletedBy": {
"delete": true,
"id": 0,
"meta": {},
"type": 0
},
"description": "string",
"disqusShortname": "string",
"editMethod": "string",
"favicon": "string",
"filter_args": {
"aggregate": {
"Distinct": true,
"Field": "string",
"Operation": "string"
},
"bulkDryExecute": true,
"fields": [
"string"
],
"filter": [
"string"
],
"id": 0,
"ids": [
0
],
"includes": [
"string"
],
"orderBy": "string",
"orderMode": "asc",
"page": 0,
"pageOffset": 0,
"pageSize": 0,
"skipAggregation": true
},
"footerTemplate": "string",
"headTemplate": "string",
"headerBGColor": "string",
"helpdoctemplate": {
"delete": true,
"id": 0,
"meta": {},
"type": 0
},
"homePageLinkEnabled": true,
"homePageLinkText": "string",
"homePageURL": "string",
"homeTemplate": "string",
"htmlHeadCode": "string",
"id": 0,
"languageCode": "string",
"linkColor": "string",
"logoImage": "string",
"metaSiteDescription": "string",
"name": "string",
"navActiveColor": "string",
"navTextColor": "string",
"pageBGColor": "string",
"password": "string",
"publicSiteEnabled": true,
"searchTemplate": "string",
"sendEmailsToInboxId": 0,
"showDateLastModified": true,
"showOnHomePage": "string",
"showSocialIcons": true,
"state": "string",
"stats": {
"articleCount": 0,
"draftCount": 0,
"publishedCount": 0,
"unpublishedCount": 0
},
"subdomain": "string",
"textColor": "string",
"touchIcon": "string",
"updatedAt": "2024-07-26T20:26:10.533Z",
"updatedBy": {
"delete": true,
"id": 0,
"meta": {},
"type": 0
}
}
],
"included": {
"helpdoctemplates": [
{
"code": "string",
"createdAt": "2024-07-26T20:26:10.533Z",
"createdBy": {
"delete": true,
"id": 0,
"meta": {},
"type": 0
},
"deletedAt": "2024-07-26T20:26:10.533Z",
"deletedBy": {
"delete": true,
"id": 0,
"meta": {},
"type": 0
},
"description": "string",
"filter_args": {
"aggregate": {
"Distinct": true,
"Field": "string",
"Operation": "string"
},
"bulkDryExecute": true,
"fields": [
"string"
],
"filter": [
"string"
],
"id": 0,
"ids": [
0
],
"includes": [
"string"
],
"orderBy": "string",
"orderMode": "asc",
"page": 0,
"pageOffset": 0,
"pageSize": 0,
"skipAggregation": true
},
"id": 0,
"name": "string",
"previewUrl": "string",
"state": "string",
"thumbnail": "string",
"updatedAt": "2024-07-26T20:26:10.533Z",
"updatedBy": {
"delete": true,
"id": 0,
"meta": {},
"type": 0
}
}
],
"users": [
{
"autoFollowOnCC": true,
"avatarURL": "string",
"createdAt": "2024-07-26T20:26:10.533Z",
"createdBy": {
"delete": true,
"id": 0,
"meta": {},
"type": 0
},
"deletedAt": "2024-07-26T20:26:10.533Z",
"deletedBy": {
"delete": true,
"id": 0,
"meta": {},
"type": 0
},
"editMethod": "string",
"email": "string",
"filter_args": {
"aggregate": {
"Distinct": true,
"Field": "string",
"Operation": "string"
},
"bulkDryExecute": true,
"fields": [
"string"
],
"filter": [
"string"
],
"id": 0,
"ids": [
0
],
"includes": [
"string"
],
"orderBy": "string",
"orderMode": "asc",
"page": 0,
"pageOffset": 0,
"pageSize": 0,
"skipAggregation": true
},
"firstName": "string",
"id": 0,
"isAppOwner": true,
"isPartTime": true,
"lastName": "string",
"ldKey": "string",
"onboarding": {
"addedFirstInbox": true,
"bookmarkPage": true,
"checkDeskHelpSite": true,
"checkSampleInbox": true,
"dismissedWelcome": true,
"exploreHelpsites": true,
"exploreReports": true,
"inviteTeam": true,
"repliedToFirstTicket": true,
"reviewedCompanySettings": true,
"reviewedProfile": true
},
"projectsCompanyId": 0,
"reviewer": true,
"role": "string",
"sendPushNotifications": true,
"sendWebNotifications": true,
"state": "string",
"ticketReplyRedirect": "string",
"timeFormatId": 0,
"timezoneId": 0,
"trainingWheelsEnrollment": {
"delete": true,
"id": 0,
"meta": {},
"type": 0
},
"updatedAt": "2024-07-26T20:26:10.533Z",
"updatedBy": {
"delete": true,
"id": 0,
"meta": {},
"type": 0
}
}
]
},
"meta": {
"page": {
"count": 0,
"hasMore": true,
"hasMorePages": true,
"page": 0,
"pageOffset": 0,
"pageSize": 0,
"pages": 0,
"records": 0
}
},
"pagination": {
"count": 0,
"hasMore": true,
"hasMorePages": true,
"page": 0,
"pageOffset": 0,
"pageSize": 0,
"pages": 0,
"records": 0
}
}