API Documentation

Introduction

Welcome to the Work4OneDollar API! Our API allows you to programmatically access our platform's features, enabling you to build integrations and automate workflows.

Base URL

https://api.work4onedollar.com/v1/

Response Format

All responses are returned in JSON format:

{
  "status": "success",
  "data": { ... },
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 100
  }
}

Authentication

All API requests require authentication using Bearer tokens. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Obtaining API Keys

You can generate API keys from your dashboard under Settings → API Access. Keys can have different permission levels:

• Read-only: Can only fetch data
• Read-write: Can create and modify resources
• Admin: Full access (use with caution)

Rate Limits

API requests are rate-limited to prevent abuse:

Projects API

List Projects

GET /projects/

Create Project

POST /projects/

{
  "title": "Build a website",
  "description": "...",
  "budget": 5000,
  "deadline": "2025-02-01"
}

Get Project Details

GET /projects/{id}/

Error Handling

The API uses standard HTTP status codes:

• 200 - Success
• 201 - Created
• 400 - Bad Request
• 401 - Unauthorized
• 403 - Forbidden
• 404 - Not Found
• 429 - Rate Limited
• 500 - Server Error