Get selected fields for a batch of boards

GET

/boards/info/batch

const url = 'https://projects.work.optidata.cloud/api/boards/info/batch?ids%5B%5D=1';
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/info/batch?ids%5B%5D=1' \
  --header 'Authorization: Bearer <token>'

Returns lightweight info for up to a batch of boards by id, restricted to boards the caller is a member of (inaccessible ids are silently omitted). By default returns id, name, icon and cuid; use options[fields][] to choose fields and options[with][]=parent to embed the parent board’s {id, name, icon}.

Authorizations

bearerAuth

Parameters

Query Parameters

ids[]

required

Array<integer>

Board ids to fetch.

options[fields][]

Array<string>

Allowed values: name icon cuid parent_id description visibility archived_at

Fields to include (id is always included).

options[with][]

Array<string>

Allowed values: parent

Relations to embed.

Responses

200

Requested boards (accessible ones only).

application/json

object

boards

Array<object>

Partial board — contains id plus the requested fields/relations.

object

Example

{
  "boards": [
    {
      "id": 42,
      "name": "Website Redesign",
      "icon": "🎨",
      "cuid": "a1b2c3d4-0000-4111-8222-333344445555"
    }
  ]
}

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

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