Cicle API
Cicle
App
Contact
  1. Card
  • Getting Started
    • Introduction
    • Authentication
    • Managing API Keys
    • Rate Limiting
    • Error Codes
  • Companies
    • Overview
    • Get Companies
      GET
  • Teams
    • Overview
    • Get Current Teams
      GET
  • Boards
    • Overview
    • Get Board with Lists and Cards
      GET
    • Get Board with Lists
      GET
  • Lists
    • Overview
    • Get All Lists by Company and Team
      GET
  • Cards
    • Overview
    • Managing Cards
    • Labels And Members
    • Checklists
    • Comments And Discussions
    • Card Members
      • Toggle Multiple Members
    • Card Labels
      • Toggle Multiple Labels
    • Card Cheers
      • Create Cheer on Card
      • Delete Cheer from Card
    • Card Comments
      • Create Comment
      • Get Card Comments
      • Update Comment on Card
      • Delete Comment from Card
    • Comment Cheers
      • Create Cheer on Comment
      • Delete Cheer from Comment
    • Card Discussions
      • Create Discussion on Comment
      • Update Discussion
      • Delete Discussion
    • Discussion Cheers
      • Create Cheer on Discussion
      • Delete Cheer from Discussion
    • Card Attachments
      • Delete Attachment from Card
      • Update Attachment Name on Card
    • Checklists
      • Checklist Items
        • Checklist Item Attachments
          • Delete Attachment from Checklist Item
          • Update Attachment Name on Checklist Item
        • Get Checklist Items
        • Create Checklist Item
        • Get Checklist Item by ID
        • Update Checklist Item Name
        • Update Checklist Item Date
        • Toggle Checklist Item Complete Status
        • Reorder Checklist Item
        • Toggle Members on Checklist Item
        • Copy Checklist Item
        • Delete Checklist Item
      • Get Checklists
      • Create Checklist
      • Update Checklist Name
      • Reorder Checklist Position
      • Copy Checklist
      • Delete Checklist
    • Card Metadata
      • Get Card Company and Team
    • Create Card
    • Copy Card
    • Archive Cards
    • Archive Cards Multi Team
    • Copy Cards Multi Team
    • Move Cards Multi Team
    • Update Cards Multi Team
    • Reorder Card Position
    • Update Card
    • Archive Card
    • Unarchive Card
    • Get Card Details
    • Get List Card
  • My Tasks
    • List All My Tasks
    • List All My Tasks In List
  • Schemas
    • Card
      • Card
      • Checklist
      • Discussion
      • Checklist Item
      • Attachment
      • Cheer
      • Comment
      • Label
      • List
      • Company
      • Team
  1. Card

Checklist

Represents a checklist group within a card. Contains a collection of checklist items with aggregated completion counts.

{
    "_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
}
Built with