Documentation Index

Fetch the complete documentation index at: https://apidocs.document360.com/llms.txt

Use this file to discover all available pages before exploring further.

Introduction

Next

The Document360 API enables you to programmatically manage your knowledge base — including articles, categories, readers, team accounts, and settings — using secure and scalable HTTP endpoints.

This documentation is intended for developers and integration partners who want to:

  • Integrate Document360 with other systems
  • Automate knowledge base publishing workflows
  • Manage content, permissions, and users through code

Overview of the v3 API

The v3 Customer API is a project-scoped REST API. Every request is made against a specific project and is authenticated with an API key.

  • Project-scoped URLs — the project ID is part of every path
  • Granular access permissions for team accounts and readers
  • Consistent, predictable request and response envelopes with snake_case fields
  • RFC 7807 problem+json error responses with machine-readable error codes
  • Support for multilingual articles, workspaces and versioning

Core concepts

Term What it means
Project A knowledge base. Every v3 URL is scoped to a project via /projects/{project_id}.
Workspace A version of a project's content. Referenced as workspace_id in request bodies.
Category / Article The content hierarchy. Categories group articles; articles hold the content and are versioned. An article version's status is draft, published or unpublished.
Team account A member of the project with a portal role and a content role.
Reader An end user who can read a Private or Mixed knowledge base.
API key The credential used to authenticate requests. Carries a portal role, content role and content-access scope.

Base URL

The v3 API is served from a regional host. Use the host that matches where your project is hosted:

Region Base URL
Europe (default) https://apihub.document360.io
United States https://apihub.us.document360.io
Canada https://apihub.ca.document360.io

All v3 endpoints are project-scoped and follow this pattern:

https://apihub.document360.io/v3/projects/{project_id}/{resource}

Authentication

Every request must be authenticated and sent over HTTPS. Send your API key in the X-API-Key header:

X-API-Key: d360_sk_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Note

The Authorization: Bearer header is reserved for OAuth 2.0 access tokens, such as those used by the interactive API reference. Use X-API-Key for API keys.

Getting started

Follow these steps to go from zero to your first published change:

  1. Generate an API key — in the portal, go to Settings > Knowledge base portal > API keys and create a key with the portal role, content role and access it needs. Copy the key immediately; it is shown only once.
  2. Make your first request — call GET /v3/projects to confirm connectivity and retrieve the project_id you will use in later calls.
  3. Learn the request and response format — all bodies and query parameters use snake_case, successful responses share a common envelope, and errors follow RFC 7807.
  4. Review the HTTP status codes so your integration reacts correctly to success, validation (422), permission (403) and rate-limit (429) responses.
  5. Automate a workflow — for example, create and publish an article, update its SEO details, or manage team accounts and readers.
  6. Explore the full API using the interactive reference.
Note

Every v3 request must be made over HTTPS and must include a valid API key in the X-API-Key header. Requests over HTTP or without a valid API key are rejected.

Need help?

Contact the Document360 support team for assistance or feedback.