Skip to content
Optiwork API Docs

List the members of a board

GET
/boards/{board}/members
curl --request GET \
  --url https://projects.work.optidata.cloud/api/boards/1/members \
  --header 'Authorization: Bearer <token>'

Returns all users who are members of the board, including soft-deleted users (so past activity can still be attributed). Membership metadata is in each user’s pivot.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
board
required
integer

Board id.

Responses

Section titled “ Responses ”

200

Section titled “200”

Board members.

Media typeapplication/json
Array
object
id
integer
uuid
string format: uuid
name
string
email
string format: email
avatar_url
string | null format: uri
username
string
company_name
string | null
role
string | null
status
string | null
deleted_at
string | null format: date-time
pivot

Membership metadata.

object
board_id
integer
user_id
integer
permission
string
Allowed values: view interact edit manage
view_mode
string | null
Allowed values: view_kanban view_list
created_at
string format: date-time
updated_at
string format: date-time
Example
[
  {
    "id": 7,
    "uuid": "0b0d2f1e-6a3c-4f7d-9a21-7c1f2e3d4a5b",
    "username": "jane.doe@acme.example",
    "email": "jane.doe@acme.example",
    "name": "Jane Doe",
    "company_name": "Acme Corp",
    "role": "user",
    "status": "active",
    "avatar_url": "https://cdn.example/avatars/jane.webp",
    "deleted_at": null,
    "pivot": {
      "board_id": 42,
      "user_id": 7,
      "permission": "manage",
      "view_mode": "view_kanban"
    }
  }
]

401

Section titled “401”

Missing, invalid or expired bearer passport.

Media typeapplication/json
object
error
string
Example
{
  "error": "JWT passport exception: Missing bearer token in request"
}

403

Section titled “403”

The authenticated user lacks the required board permission.

Media typeapplication/json
object
message
string
Example
{
  "message": "This action is unauthorized."
}

404

Section titled “404”

Resource not found, or a nested resource does not belong to its parent in the path.

Media typeapplication/json
object
message
string
Example
{
  "message": "Not found."
}