Skip to content

Search users that can be @-mentioned on the board

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

Returns the board’s members (max 50, ordered by name), optionally filtered by a name/email substring — the candidates for @-mentions in card content and comments.

board
required
integer

Board id.

filter
string | null

Name/email substring filter.

Mentionable users.

Media typeapplication/json
Array<object>
object
id
integer
uuid
string format: uuid
name
string
email
string format: email
avatar_url
string | null format: uri
Examplegenerated
[
{
"id": 1,
"uuid": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example",
"email": "hello@example.com",
"avatar_url": "https://example.com"
}
]

Missing, invalid or expired bearer passport.

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

The authenticated user lacks the required board permission.

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

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."
}