Cicle API
Cicle
App
Contact
  1. Cards
  • Getting Started
    • Introduction
    • Authentication
    • Managing API Keys
    • Rate Limiting
    • Error Codes
  • Companies
    • Overview
    • Get Companies
  • Teams
    • Overview
    • Get Current Teams
  • Boards
    • Overview
    • Get Board with Lists and Cards
    • Get Board with Lists
  • Lists
    • Overview
    • Get All Lists by Company and Team
  • 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
      POST
    • Copy Card
      POST
    • Archive Cards
      PATCH
    • Archive Cards Multi Team
      PATCH
    • Copy Cards Multi Team
      PATCH
    • Move Cards Multi Team
      PATCH
    • Update Cards Multi Team
      PATCH
    • Reorder Card Position
      PATCH
    • Update Card
      PATCH
    • Archive Card
      PATCH
    • Unarchive Card
      PATCH
    • Get Card Details
      GET
    • Get List Card
      GET
  • 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. Cards

Overview

Cards#

Cards are the core building blocks in Cicle. They represent tasks, items, or action points within your project management workflow.

What is a Card?#

A card is a discrete unit of work that belongs to a list, which belongs to a board. Cards can contain checklists, comments, attachments, labels, and members.

Data Hierarchy#

Company
  └── Team
        └── Board
              └── List
                    └── Card
                          ├── Checklists
                          ├── Comments
                          ├── Attachments
                          ├── Labels
                          └── Members
A card is always scoped to a company and team. When using a Company API Key, these are automatically injected from the key's binding.

Key Concepts#

Completion Status#

Cards can be marked as complete. The complete field tracks the status, type, and timestamp of completion. This is useful for tracking progress and generating reports.

Archiving#

Cards can be archived to hide them from default views without permanently deleting them. Archived cards can be restored at any time.

Multi-Team Operations#

Cards can be copied, moved, or updated across different teams in a single request using the bulk endpoints. This is useful for integrations that need to synchronize data across teams.

Members and Labels#

Cards can be assigned to multiple members and tagged with color-coded labels. These are used for filtering, assignment, and categorization.

Permission Scopes#

Card operations use these scopes:
ScopePurpose
card:readRead cards and their data
card:writeCreate, update cards; manage checklists, labels, members, comments
card:deleteArchive cards; delete checklists, attachments
card:comment:readRead comments and discussions
card:comment:writeCreate and update comments and discussions
card:comment:deleteDelete comments and discussions
Previous
Get All Lists by Company and Team
Next
Managing Cards
Built with