Skip to main content

​
REST API Guide

The Woes REST API is documented in the API Reference tab. Keep implementation work there so product guides remain focused on how to use Woes.

​
What The REST API Covers

  • Conversations.
  • Issues.
  • Clients.
  • Agents.
  • Sources.
  • Definitions.
  • Usage.
  • Analytics.

​
Before Building

  1. Create a workspace API key in Keys.
  2. Keep the full woesk_ secret server-side.
  3. Choose the minimum scopes your integration needs.
  4. Test calls in the API Reference playground.
  5. Review response boundaries before storing returned data.
Last modified on June 30, 2026