Fairlx Logo

Beta

Projects API

Create and manage projects within workspaces.

Overview

Projects are containers for work items, sprints, and backlogs. Each project belongs to a workspace, and its members and roles decide who can open it.

Note

These are the web app's own routes under https://app.fairlx.com/api. They accept only a signed-in session and may change. Programmatic access goes through the Fairlx MCP endpoint.

List Projects

Retrieve the projects in a workspace that you can open.

Request
GET /api/projects?workspaceId=ws_abc123
Response
{
  "data": {
    "documents": [
      {
        "$id": "proj_xyz789",
        "name": "Mobile App v2",
        "description": "Next generation mobile application",
        "imageUrl": "https://...",
        "workspaceId": "ws_abc123",
        "spaceId": null,
        "deadline": "2024-06-30",
        "assignedTeamIds": ["team_001"],
        "customWorkItemTypes": [],
        "customPriorities": [],
        "customLabels": [],
        "$createdAt": "2024-01-15T10:00:00Z"
      }
    ],
    "total": 1
  }
}

Note

Workspace admins see every project. Other members see the projects they belong to.

Get Project

Retrieve details for a specific project.

Request
GET /api/projects/:projectId

Create Project

Create a new project in a workspace.

Request
POST /api/projects
Content-Type: multipart/form-data

name=Mobile App v2
description=Next generation mobile application
workspaceId=ws_abc123
deadline=2024-06-30
spaceId=space_001
image=(file)

Request Body

FieldTypeRequiredDescription
namestringYesProject name
workspaceIdstringYesParent workspace ID
descriptionstringNoProject description
deadlinestringNoISO date string
spaceIdstringNoSpace to organize under
imageFileNoProject image

Update Project

Update an existing project.

Request
PATCH /api/projects/:projectId
Content-Type: multipart/form-data

name=Mobile App v3
customWorkItemTypes=[{...}]
customPriorities=[{...}]

Delete Project

Delete a project and all related work items and time logs.

Warning

Deleting a project permanently removes all tasks, time logs, and related data.
Request
DELETE /api/projects/:projectId

Project Analytics

Get task analytics for a specific project.

Request
GET /api/projects/:projectId/analytics

Team Assignment

Assign or unassign teams to projects for access control.

Assign Team
POST /api/projects/:projectId/teams/:teamId
Unassign Team
DELETE /api/projects/:projectId/teams/:teamId

Tip

Use POST /projects/:id/copy-settings to copy custom settings from another project in the same workspace.