Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ruddr.io/llms.txt

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

The Ruddr API is a RESTful API that lets you programmatically access and manage your Ruddr workspace data, including clients, projects, members, time entries, expenses, invoices, and more.

​
Get Your API Key

  1. Navigate to Settings > API Keys in your Ruddr workspace
  2. Click Create API Key
  3. Optionally name the key to identify its purpose or owner
  4. Click Submit to generate the key
The full token is only displayed once. Copy and store it in a secure location like a password manager. After creation, only the last 4 characters are visible.

​
Make Your First Request

Test your connection by fetching your workspace details: 
curl https://www.ruddr.io/api/workspace \
  -H "Authorization: Bearer YOUR_API_KEY"
A successful response returns your workspace details: 
{
  "id": "af7d3ba3-785d-4bae-9d1f-6897e15db5f6",
  "name": "My Workspace"
}

​
Next Steps

​
Getting Started

  • Review Conventions for base URL, data formats, and general rules
  • Learn about Authentication and how to manage API keys
  • Understand Rate Limits and how to handle throttled requests
  • Explore List Endpoints for pagination, sorting, and filtering
  • Read about Errors for HTTP status codes and error response format

​
Resources

  • Explore the API Reference to browse all available endpoints
  • Download the OpenAPI Spec for client generation and API exploration
  • Check the Changelog for the latest API updates