Board Members
Manage who has access to a board and their roles.
Board members control who can view and interact with a specific board. Members can be individual users or part of a team assignment.
List Board Members
GET /api/v1/boards/{boardId}/membersQuery Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| userRole | string | No | Filter by role: Admin, TeamMember, or Customer |
Example Response
{
"data": [
{
"userId": "usr_abc123",
"name": "Alex Smith",
"email": "[email protected]",
"role": "BOARD_ADMIN",
"joinedAt": "2025-01-15T10:00:00Z"
}
]
}List Board Customers
GET /api/v1/boards/{boardId}/members/customersReturns only members with the Customer role. Useful for filtering external collaborators.
Add Board Member
POST /api/v1/boards/{boardId}/membersRequest Body
| Field | Type | Required | Description |
|---|---|---|---|
| userId | string | Yes | User ID to add |
| role | string | No | Board role: BOARD_ADMIN, BOARD_MEMBER, or BOARD_VIEWER |
Example Request
{
"userId": "usr_abc123",
"role": "BOARD_MEMBER"
}Get Board Member
GET /api/v1/boards/{boardId}/members/{userId}Returns details for a specific board member.
Remove Board Member
DELETE /api/v1/boards/{boardId}/members/{userId}Removes a user from the board. Returns 204 No Content.