API Reference
The TechWriter API is organized around REST. Our API features predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and leverages standard HTTP response codes, authentication methods, and verbs.
You can interact with the TechWriter API in a sandbox environment to safely test your integrations without impacting your production workspace or live assets. The authentication token included in your request determines whether you are operating in live mode or within a test environment.
The TechWriter API focuses on individual resource manipulation to maintain high performance and data integrity. This ensures that every change to your documentation is handled with precision.
The API structure adapts as we release new versions and introduce specialized functionality. Access your developer dashboard to view documentation tailored to your specific account, complete with your unique API keys and live data previews.
Base URL
https://api.techwriter.ioJust getting started?
Review our guide to learn how to retrieve your first set of resources.
View GET Users →Need a custom integration?
Explore our OAuth implementation to build secure, third-party applications.
Explore OAuth →API at a glance
Every endpoint follows the same conventions — read the OAuth and GET Users pages for live examples.