Operations related to publications, including publishing and exporting.
Returns information on all projects and publications available to the user making the request.
curl https://your-portal.clickhelp.co/api/v1/projects \
--header 'Authorization: Basic username:password'
[
{
"id": "…",
"title": "…",
"createdOn": "2026-01-23T22:10:04.180Z",
"visibility": "Private",
"parentId": "…",
"fullUrl": "https://example.com",
"url": "…",
"parentUrl": "…"
}
]Returns information about a single project or publication. The parentId field will be null for projects and will contain the project ID for publications.
- publicationIdstringrequired
The ID of the project or publication.
curl https://your-portal.clickhelp.co/api/v1/projects/ \
--header 'Authorization: Basic username:password'
{
"id": "…",
"title": "…",
"createdOn": "2026-01-23T22:10:04.180Z",
"visibility": "Private",
"parentId": "…",
"fullUrl": "https://example.com",
"url": "…",
"parentUrl": "…"
}Updates a publication's properties, like its visibility, title, URL, etc. The updatedFields parameter specifies which fields to update.
- publicationIdstringrequired
The ID of the project or publication.
The properties to update.
The properties to update for a publication.
A comma-separated list of fields that will be updated.
title,visibilityThe new publication title.
The new publication URL part.
The new visibility value.
- Private
- Restricted
- Public
The new default topic ID.
The new content of the Home page view.
The new content of the header.
The new content of the footer.
Whether to use the "No Frame" master page.
Whether to enable comments for the entire publication.
The ID of the new branding settings (skin) to apply.
Whether to use absolute URLs for files in this publication.
An array of strings containing the names of the Power Reader Access Groups that will have access to the publication. For the Restricted visibility only.
curl https://your-portal.clickhelp.co/api/v1/projects/ \
--request PATCH \
--header 'Authorization: Basic username:password' \
--header 'Content-Type: application/json' \
--data '{
"updatedFields": "title,visibility",
"title": "",
"url": "",
"visibility": "Private",
"defaultTopicId": "",
"homePageContent": "",
"header": "",
"footer": "",
"noFrame": true,
"isCommentsEnabled": true,
"skinId": "",
"isUseAbsoluteFileUrls": true,
"accessGroups": [
""
]
}'
{
"id": "…",
"title": "…",
"createdOn": "2026-01-23T22:10:04.180Z",
"visibility": "Private",
"parentId": "…",
"fullUrl": "https://example.com",
"url": "…",
"parentUrl": "…"
}Performs an action on a project or publication, like creating a backup or exporting. The exact behavior is determined by the 'action' query parameter.
- publicationIdstringrequired
The ID of the project or publication.
- actionstring enumrequired
The action to perform.
- download
- export
- publish
- import
The request body, dependent on the action.
The properties for an export request.
Schema for creating a new publication.
The properties to update for a publication.
Defines the source for an API spec import to an existing project.
curl https://your-portal.clickhelp.co/api/v1/projects/ \
--request POST \
--header 'Authorization: Basic username:password' \
--header 'Content-Type: application/json' \
--data '{
"outputFileName": ""
}'
{
"taskKey": "…"
}