Search users that could be added to the board

GET

/boards/{board}/members/assignables

const url = 'https://projects.work.optidata.cloud/api/boards/1/members/assignables?query=example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://projects.work.optidata.cloud/api/boards/1/members/assignables?query=example' \
  --header 'Authorization: Bearer <token>'

Searches the tenant’s users by name or email (excluding the caller) so they can be invited as board members. Returns at most 50 users ordered by name.

Authorizations

bearerAuth

Parameters

Path Parameters

board

required

integer

Board id.

Query Parameters

query

required

string

Name/email search string.

Responses

200

Matching users.

application/json

object

assignable

Array<object>

object

integer

uuid

string format: uuid

name

string

email

string format: email

avatar_url

string | null format: uri

Example

{
  "assignable": [
    {
      "id": 8,
      "uuid": "9f8e7d6c-5b4a-3f2e-1d0c-b9a8c7d6e5f4",
      "name": "John Smith",
      "email": "john.smith@acme.example"
    }
  ]
}

401

Missing, invalid or expired bearer passport.

application/json

object

error

string

Example

{
  "error": "JWT passport exception: Missing bearer token in request"
}

403

The authenticated user lacks the required board permission.

application/json

object

message

string

Example

{
  "message": "This action is unauthorized."
}

404

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

application/json

object

message

string

Example

{
  "message": "Not found."
}

422

Validation failed.

application/json

object

message

First validation error message.

string

errors

Map of field name → list of error messages.

object

key

additional properties

Array<string>

Example

{
  "message": "The name field is required.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}