Get Checklists

GET

https://primaryapi.cicle.app/api/v1/cards/:cardId/checklists

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

Maintainer:Putu Aditya

Get all checklists for a card with pagination support.

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

Checklists retrieved successfully

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://primaryapi.cicle.app/api/v1/cards//checklists?companyId=&teamId=&page=1&limit=10' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "page": 0,
    "limit": 0,
    "total": 0,
    "totalPage": 0,
    "data": [
        {
            "_id": "string",
            "name": "string",
            "checklistItems": [
                {
                    "_id": "string",
                    "name": "string",
                    "complete": {
                        "status": true,
                        "type": "done"
                    },
                    "creator": "string",
                    "isNotified": {
                        "startOneHour": true,
                        "startOneDay": true,
                        "dueOneHour": true,
                        "dueOneDay": true
                    },
                    "checklist": "string",
                    "card": "string",
                    "team": "string",
                    "company": "string",
                    "attachments": [
                        {
                            "_id": "string",
                            "name": "string",
                            "url": "string",
                            "creator": {
                                "_id": "string",
                                "fullName": "string",
                                "photoUrl": "string"
                            },
                            "type": "string",
                            "mimeType": "string",
                            "isDeleted": true,
                            "company": "string",
                            "team": "string",
                            "card": "string",
                            "seen": [
                                "string"
                            ],
                            "cheers": [
                                {
                                    "_id": "string",
                                    "content": "string",
                                    "creator": {
                                        "_id": "string",
                                        "photoUrl": "string"
                                    },
                                    "receiver": "string",
                                    "primaryParent": {
                                        "id": "string",
                                        "type": "string"
                                    },
                                    "secondaryParent": {
                                        "id": "string",
                                        "type": "string"
                                    },
                                    "isNotified": true,
                                    "comment": "string",
                                    "card": "string",
                                    "featureType": "string",
                                    "company": "string",
                                    "team": "string",
                                    "createdAt": "string",
                                    "updatedAt": "string",
                                    "__v": 0,
                                    "notification": "string"
                                }
                            ],
                            "createdAt": "string",
                            "updatedAt": "string",
                            "__v": 0
                        }
                    ],
                    "members": [
                        {
                            "_id": "string",
                            "fullName": "string",
                            "photoUrl": "string"
                        }
                    ],
                    "createdAt": "string",
                    "updatedAt": "string",
                    "__v": 0
                }
            ],
            "checklistItemsCount": {
                "completed": 0,
                "total": 0
            },
            "creator": "string",
            "card": "string",
            "team": "string",
            "company": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "__v": 0
        }
    ]
}

Delete Checklist Item

Create Checklist