Get Board with Lists and Cards

GET

https://primaryapi.cicle.app/v2/boards/:boardId

Last modified:2026-07-02 07:23:00

Maintainer:Putu Aditya

Retrieve a board with its lists and cards. Returns the board details with all lists and their cards populated.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Query Params

Responses

🟢200Success

application/json

Get board list card successful

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://primaryapi.cicle.app/v2/boards/?companyId=&teamId=&filter=all&limitList=&limitCard=0' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "message": "string",
    "board": {
        "_id": "string",
        "name": "string",
        "desc": "string",
        "company": "string",
        "team": "string",
        "lists": [
            {
                "_id": "string",
                "name": "string",
                "cards": [
                    {
                        "_id": "string",
                        "name": "string",
                        "cover": "string",
                        "creator": {
                            "_id": "string",
                            "fullName": "string",
                            "photoUrl": "string"
                        },
                        "members": [
                            {
                                "_id": "string",
                                "fullName": "string",
                                "photoUrl": "string"
                            }
                        ],
                        "checklists": [
                            "string"
                        ],
                        "allChecklistItemsCount": {
                            "completed": 0,
                            "total": 0
                        },
                        "complete": {
                            "status": true,
                            "type": "string",
                            "setAt": "string",
                            "updatedAt": "string"
                        },
                        "isNotified": {
                            "startOneHour": true,
                            "startOneDay": true,
                            "dueOneHour": true,
                            "dueOneDay": true
                        },
                        "archived": {
                            "status": true
                        },
                        "isPublic": true,
                        "workload": {
                            "value": null,
                            "measurement": "string"
                        },
                        "company": "string",
                        "team": "string",
                        "board": "string",
                        "list": "string",
                        "seen": [
                            "string"
                        ],
                        "createdAt": "string",
                        "updatedAt": "string",
                        "__v": 0
                    }
                ],
                "totalCard": 0,
                "archived": {
                    "status": true
                },
                "complete": {
                    "status": true,
                    "type": "string"
                },
                "createdAt": "string",
                "updatedAt": "string"
            }
        ],
        "labels": [
            {
                "_id": "string",
                "name": "string",
                "color": {
                    "_id": "string",
                    "name": "string",
                    "value": "string"
                }
            }
        ],
        "totalList": 0,
        "createdAt": "string",
        "updatedAt": "string"
    },
    "currentTeam": {
        "_id": "string",
        "name": "string",
        "desc": "string",
        "creator": "string",
        "company": "string",
        "type": "string",
        "members": [
            {
                "_id": "string",
                "photoUrl": "string",
                "bio": "string",
                "status": "string"
            }
        ],
        "boards": [
            "string"
        ],
        "bucket": "string",
        "groupChat": "string",
        "blast": "string",
        "checkIn": "string",
        "schedule": "string",
        "archived": {
            "status": true,
            "archivedAt": "string"
        },
        "createdAt": "string",
        "updatedAt": "string"
    }
}

Overview

Get Board with Lists