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

Authentication

All requests to the Cicle Open API must include your API key in the Authorization header. This guide explains how to authenticate.

Request Format#

Every API request must include the Authorization header with your API key as a Bearer token:
Authorization: Bearer your_api_key_here

API Key Types#

TypePrefixDescription
Company API Keycicle_bz_Bound to a specific company and a team
User API Keycicle_user_Bound to a specific user account

Company API Key Authentication#

When you authenticate with a Company API Key, the companyId and teamId are automatically injected from the key's binding. You do not need to pass them as query parameters.

Example Request#

The server will automatically scope all data operations to the company and team bound to this key.

User API Key Authentication#

When you authenticate with a User API Key, the system acts as the user who owns the key. The user's existing roles and permissions are applied.

Example Request#

Scope Restrictions (Company API Keys)#

Company API Keys can be configured with specific permission scopes. If the key does not have the required scope for a route, the request will be rejected with 403 Forbidden.
For example, a key with only card:read scope cannot create or update cards.
See the API Keys guide for details on managing scopes.

Subscription Requirement#

Company API Keys require an active company subscription. If the company's subscription has expired or is inactive, all API requests will be rejected with 402 Payment Required.

Error Responses#

StatusMeaning
401API key is invalid, expired, or not found
402Company subscription is expired or inactive
403API key does not have the required permission scope
429Rate limit exceeded
See Error Codes for more details.
Previous
Introduction
Next
Managing API Keys
Built with