REST API Overview

Introduction

The Fairlx REST API allows you to programmatically access and manage your workspaces, projects, work items, and more. The API follows RESTful conventions and returns JSON responses.

Authentication

All API requests require authentication using an API key. You can generate API keys from your account settings or organization admin panel.

Include your API key in the request header:

curl -X GET "https://api.fairlx.com/v1/workspaces" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Base URL

All API requests should be made to:

https://api.fairlx.com/v1

Common Endpoints

Here are some commonly used endpoints:

Workspaces

Projects

Error Handling

The API uses standard HTTP status codes to indicate success or failure:

• 200 OK — Request succeeded
• 201 Created — Resource created successfully
• 400 Bad Request — Invalid request parameters
• 401 Unauthorized — Missing or invalid API key
• 403 Forbidden — Insufficient permissions
• 404 Not Found — Resource not found
• 429 Too Many Requests — Rate limit exceeded
• 500 Internal Server Error — Server error

Error responses include a JSON body with details:

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The 'name' field is required",
    "details": {
      "field": "name",
      "reason": "required"
    }
  }
}