Members API
Manage workspace membership and roles.
Overview
Members represent users who have access to a workspace. Each member has a role that determines their permissions within the workspace.
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.Member Roles
| Role | Description |
|---|---|
| OWNER | Full control including workspace deletion |
| ADMIN | Manage settings, members, and all content |
| MEMBER | Create and manage work items |
List Members
Retrieve all members in a workspace with their user details.
Request
GET /api/members?workspaceId=ws_abc123Response
{
"data": {
"documents": [
{
"$id": "member_001",
"userId": "user_abc",
"workspaceId": "ws_abc123",
"role": "ADMIN",
"name": "John Doe",
"email": "[email protected]",
"profileImageUrl": "https://..."
}
],
"total": 1
}
}Get Current Member
Get the current authenticated user's membership and permissions for a workspace.
Request
GET /api/members/current?workspaceId=ws_abc123Response
{
"data": {
"$id": "member_001",
"userId": "user_abc",
"workspaceId": "ws_abc123",
"role": "ADMIN",
"permissions": [
"CREATE_SPRINTS",
"START_SPRINTS",
"COMPLETE_SPRINTS",
"CREATE_TASKS",
"EDIT_TASKS",
"DELETE_TASKS"
]
}
}Tip
Use this endpoint to check what actions the current user can perform before making API calls.
Update Member Role
Change a member's role. Requires Admin role.
Request
PATCH /api/members/:memberId
Content-Type: application/json
{
"role": "ADMIN"
}Warning
Cannot downgrade the only member of a workspace.
Remove Member
Remove a member from a workspace. Admins can remove other members, and any member can remove themselves.
Request
DELETE /api/members/:memberIdRestrictions
- Cannot remove the last member of a workspace
- Owners cannot leave without transferring ownership first
- Non-admins can only remove themselves
- Cannot remove the workspace owner
Note
To invite new members, use the workspace invite code via
POST /workspaces/:id/join.