Knowledge
GET
/api/v1/workspaces/{workspaceId}/knowledge/sites/{siteId}
Scope knowledge:read
Read one knowledge site by id, including locales and whether it is enabled.
Pfad
siteIdPflicht
string (uuid)
Knowledge site identifier.
workspaceIdPflicht
string
Workspace that owns the resource.
Antworten
200KnowledgeSiteDtoThe request succeeded. The JSON body contains url, data, and meta. The linked schema is data.
Knowledge site.
id
string (uuid)
Identifier.
name
string
Display name.
publicSlug
string
Public slug.
isEnabled
boolean
Whether this is enabled.
isPrimary
boolean
Whether this is primary.
defaultLocale
string
Default locale.
locales
string[]
Language codes this item is available in.
allowAnonymousComments
boolean
Whether to allow anonymous comments.
styleSetId
string (uuid)
Identifier of the style set.
preferredHostnameId
string (uuid)
Identifier of the preferred hostname.
homeCopy
object
homeTitle
string
Home title.
homeDescription
string
Home description.
contactUrl
string
URL of the contact.
ctaAboveId
string (uuid)
Identifier of the cta above.
ctaSidebarId
string (uuid)
Identifier of the cta sidebar.
ctaBelowId
string (uuid)
Identifier of the cta below.
footerLinks
object
fallbackHostname
string
Fallback hostname.
fallbackHostnameStatus
string
Fallback hostname status.
apiSnippetLanguages
string[]
API snippet languages.