Get a checklist with its items

GET

/boards/{board}/cards/{card}/checklists/{checklist}

const url = 'https://projects.work.optidata.cloud/api/boards/1/cards/1/checklists/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/1/cards/1/checklists/1 \
  --header 'Authorization: Bearer <token>'

Returns the checklist with its items and completion counters.

Authorizations

bearerAuth

Parameters

Path Parameters

board

required

integer

Board id.

card

required

integer

Card id (must belong to the board).

checklist

required

integer

Checklist id (must belong to the card).

Responses

200

The checklist.

application/json

object

integer

card_id

integer

title

string

<= 255 characters

items

Array<object>

object

integer

checklist_id

integer

title

string

<= 255 characters

is_completed

boolean

completed_at

string | null format: date-time

due_date

string | null format: date-time

due_date_status

string | null

Allowed values: OVERDUE NEAR FAR

human_due_date

string | null

short_locale_date

string | null

assignees

Array<object>

object

integer

uuid

string format: uuid

name

string

avatar_url

string | null format: uri

created_at

string format: date-time

items_count

integer

items_completed_count

integer

created_at

string format: date-time

Example

{
  "id": 120,
  "card_id": 9001,
  "title": "Launch checklist",
  "items": [
    {
      "id": 501,
      "checklist_id": 120,
      "title": "Update DNS records",
      "is_completed": false,
      "completed_at": null,
      "due_date": null,
      "due_date_status": null,
      "human_due_date": null,
      "short_locale_date": null,
      "assignees": [],
      "created_at": "2026-07-20T14:02:00.000000Z"
    }
  ],
  "items_count": 1,
  "items_completed_count": 0,
  "created_at": "2026-07-20T14:00:00.000000Z"
}

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