REST API Overview
How programmatic access to Fairlx works, and the routes the web app uses.
Introduction
The Fairlx web app talks to one REST API. It follows RESTful conventions and returns JSON. These pages list its routes for workspaces, projects, work items, and more.
Note
Authentication
Programmatic access goes through the Fairlx MCP endpoint at https://app.fairlx.com/api/mcp. An admin creates an API token for it in the project's MCP integration. The REST routes the web app uses accept only a signed-in session and may change.
Warning
Base URL
The web app's routes live under:
https://app.fairlx.com/apiCommon Endpoints
Here are some commonly used endpoints:
Workspaces
| Method | Endpoint | Description |
|---|---|---|
GET | /workspaces | List all workspaces |
POST | /workspaces | Create a workspace |
GET | /workspaces/:id | Get workspace details |
PATCH | /workspaces/:id | Update a workspace |
DELETE | /workspaces/:id | Delete a workspace |
Projects
| Method | Endpoint | Description |
|---|---|---|
GET | /projects?workspaceId=:id | List projects in workspace |
POST | /projects | Create a project |
GET | /projects/:id | Get project details |
Error Handling
The API uses standard HTTP status codes to indicate success or failure:
200 OK— Request succeeded201 Created— Resource created successfully400 Bad Request— Invalid request parameters401 Unauthorized— Not signed in403 Forbidden— Insufficient permissions404 Not Found— Resource not found429 Too Many Requests— Rate limit exceeded500 Internal Server Error— Server error
Error responses include a JSON body. Most carry a message in error, and some add a machine-readable code:
{
"error": "Unauthorized"
}{
"error": "...",
"code": "PLAN_PLUS_REQUIRED"
}A request that fails validation returns 400 with the validation issues:
{
"success": false,
"error": {
"name": "ZodError",
"issues": [
{
"code": "invalid_type",
"expected": "string",
"received": "undefined",
"path": ["name"],
"message": "Required"
}
]
}
}