Get Board with Lists

GET

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

Last modified:2026-07-02 06:51:27

Maintainer:Putu Aditya

Retrieve a board with its lists. Returns the board details with all lists populated (without cards).

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 lists successful

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

{
    "message": "string",
    "totalList": 0,
    "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"
            },
            "config": {
                "moveCard": {
                    "status": true,
                    "users": [
                        {
                            "_id": "string",
                            "fullName": "string",
                            "photoUrl": "string"
                        }
                    ]
                }
            },
            "createdAt": "string",
            "updatedAt": "string"
        }
    ]
}

Get Board with Lists and Cards

Overview