Cicle API
Cicle
App
Contact
  1. Companies
  • 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
      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. Companies

Overview

Companies#

A company is the top-level organizational unit in Cicle. All data — teams, boards, cards — belongs to a company.

How Companies Work with API Keys#

When you create a Company API Key, it is bound to one specific company. This means:
All requests using this key automatically operate within that company's data.
You do not need to pass companyId as a query parameter — it is injected from the key's binding.
The key cannot access data from other companies.

Role Hierarchy#

Members within a company have different roles that determine their access level:
RoleWhat They Can Do
SuperFull access. Company creator.
AdminAlmost everything. Cannot remove super admins.
ManagerManage teams if owner. Invite/remove people below.
SPVSupervisor. Limited team management.
MemberRead-only. Can comment on things they create.
GuestRead-only.
When using a Company API Key, the system operates with admin role by default. This is a design decision — the actual access control is handled by the API key's permission scopes, not the role.

Subscription Requirement#

Company API Keys require an active subscription. If the subscription expires, all API requests using that key will be rejected with 402 Payment Required.
Previous
Error Codes
Next
Get Companies
Built with