Skip to content

Rest API

Browse the content library

GET
/api/v1/wiki/tree

List the content library (wiki) entries directly under a path. Call it repeatedly to walk the tree.

Notes

  • Scoped to the workspace in x-website-id
  • A very wide directory is cut short and the response carries truncated: true
x-api-key
required
string

Your API key from account settings.

x-user-email
required
string

The email address of your user.

x-account-id
required
string

The ID of your account. You can find this in the account settings.

x-website-id
required
string

The ID of the workspace you want to use.

path
string
default: /

Directory to list. Defaults to the root, /.

The entries under the path.

object
path
string
children
Array<object>
object
truncated

Present and true only when the listing was cut short.

boolean

Unauthorized - invalid API key.

Not found - the website does not belong to the account.

Bad request - missing websiteId.