Retrieve content from Q.wiki process modules via Content API

Modified on Thu, 2 Apr at 4:12 PM

The Q.wiki Content API for process modules allows you to query content from process modules programmatically. Typical use cases include integration with enterprise search, chatbots, or automated reporting.

Overview

The API allows access to content from process modules while respecting the permissions of the respective user. Only pages that you have access to will be returned.

You can find the complete technical documentation at https://<tenant>.qwikinow.de/external-api/v1/docs (replace <tenant> with the name of your Q.wiki instance).

Create an authentication token

To access the API, you need a personal token. Any user can create tokens with their own permissions.

Navigate to User > My Profile > Content API.

Navigation to User, My Profile, Content API in Q.wiki

Click on Add Token.

Add Token button in the Content API overview

Give the token a name and define its validity period.
Save the token securely – it will be needed for all API requests.

Attention: The token is only displayed once. If you lose it, you must create a new one.

Tip: For integration with an enterprise search, it can be useful to create a dedicated dummy user in Q.wiki through which you control the desired permissions. This ensures that no sensitive content accidentally appears in the search.

Known limitations (Beta)

Topic	Limitation
Module filter	Currently does not return information about organizational units (OU).
Module IDs	Must be passed as a comma-separated list.
Permissions	Authorized users per page are currently not retrievable via the API.
Change proposals	Change proposals have no effect on the `last_changed_at` field.
Page owner	Currently only returned as an ID. A separate endpoint is planned.

Retrieve content from Q.wiki process modules via Content API

Overview

Create an authentication token

Known limitations (Beta)

Related articles