Skip to main content
General conventions that apply across all Ruddr API endpoints.

​
Base URL

All API requests use the following base URL over HTTPS: 
https://www.ruddr.io/api/workspace

​
Data Formats

  • JSON: All request and response bodies are JSON-encoded. Set the Content-Type header to application/json for requests with a body.
  • camelCase: Object attribute names use camelCase (not snake_case or kebab-case).
  • UUIDs: All resource identifiers are UUID v4 strings.
  • Slugs: Slugs use lowercase alphanumeric characters with hyphens.
  • Dates: Date values use ISO 8601 format — 2021-07-24 for dates and 2021-07-24T17:40:03.633Z for timestamps.
  • Null handling: Empty strings are automatically converted to null on write. Setting a property to null unsets it.