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

Managing API Keys

This guide explains how to create and manage API keys for your integrations.

Where to Manage API Keys#

All API key management is done through the web UI at:
https://my.cicle.app/companies/[company id]/open-api
From there you can create, view, update, and delete API keys.

Company API Keys#

Company API Keys are used for server-to-server integrations. They are bound to a specific company and a team.

Creating a Key#

To create a Company API Key, you need admin role or above. When creating a key, you define:
token name — A recognizable name for the key
description — What this key is used for
bot name — Display name for the bot user that represents this key
expired — When the key should stop working (optional)
team — Bind the key to a specific team
permission/scope — Which operations the key can perform (see Permission Scopes below)
Important: The raw API key is shown only once at creation time. Store it securely — you cannot retrieve it later.

Updating a Key#

You can update the token name, desc, expired, team, and permission/scope at any time from the web UI.

Deleting a Key#

Deleting a Company API Key also removes the associated bot user.

User API Keys#

User API Keys act as the authenticated user directly. They inherit the user's existing roles and permissions.

Creating a User Key#

No special role is required — any authenticated user can create a personal API key. User API keys are displayed across all companies in the web UI, since they are not bound to any specific company.
When creating a key, you define:
token name — A recognizable name for the key
description — What this key is used for
expired — When the key should stop working (optional)

Updating and Deleting#

You can update the token name, desc, and expired of your personal keys, or delete them entirely from the web UI.

Permission Scopes#

Company API Keys use scopes to control what operations the key can perform.

Card Scopes#

ScopePurpose
card:readRead cards, checklists, and labels
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

Security Notes#

Raw API keys are never stored in the database. Only a SHA-256 hash is persisted.
The raw key is shown only once at creation time. If lost, you must create a new key.
Company API keys are bound to their company and team. They cannot access data from other companies.
Expired keys are rejected immediately with 401 Unauthorized.
Previous
Authentication
Next
Rate Limiting
Built with