Please enable JavaScript.
Coggle requires JavaScript to display documents.
🚀 Coggle API v2 (REST Справочник) - Coggle Diagram
🚀
Coggle API v2
(REST Справочник)
🔐
Authentication
OAuth2 & Security
GET /dialog/authorize
consent page redirect
?redirect_uri
#
?scope
Scopes
?client_id
?response_type=code
Response: redirect with
code
#
POST /token
exchange code for access token
HTTP Header: Authorization
Basic client_id:client_secret
HTTP Header: Content-Type
application/json
code
redirect_uri
grant_type=authorization_code
Response
access_token
token_type=bearer
scopes
read
read user diagram list & metadata
write
create, edit & delete diagrams
User Badge
GET /api/1/badge
#
Response:
id
: client-specific user ID
Libraries
node.js: passport-coggle-oauth2
🌿
Nodes
Hierarchy API
POST /api/1/diagrams/:diagram/nodes
create new node
#
body:
Node
response body:
Node
Location Header:
/nodes/:node_id
GET /api/1/diagrams/:diagram/nodes
get full node tree
#
response: Array containing
diagram root
Node Tree
PUT /api/1/diagrams/:diagram/nodes/:node
update node
#
body:
Node
response:
Node
DELETE /api/1/diagrams/:diagram/nodes/:node
remove node & children
#
Response: { count: N }
PUT /api/1/diagrams/:diagram/nodes?action=rearrange
auto layout nodes
#
response:
Node Tree
Node Resource
_id: (readonly) Unique node ID
text: Node label markdown
parent: Parent node ID
colour: Edge color hex
offset: { x, y } position offset
text_size: text font size
width: text block width
Node Tree resource
(readonly)
_id & text & offset
children: array of
Node Tree
📐
Syntax & Rules
Manual Cheatsheet
📝
Markdown & Icons
Emojis: :lock:, :rocket:, :file_cabinet:
Links:
Text
🧮
Calculations & Formulas
Progress: =(COUNT(CHILDREN))/4
🔗
Crosslinks Rules
Format:
Anchor
Place in SOURCE node only
🚀
Diagrams
API & Resource
GET /api/1/diagrams
list diagrams for a user
?access_token
#
?folder
= own (personal diagrams)
= shared (shared diagrams)
= :folderId (diagrams in folder)
#
Response: Array of
Diagram
GET /api/1/diagrams/:diagram
get specific diagram
#
Response:
Diagram
POST /api/1/diagrams
create new diagram
body:
Diagram
response:
Diagram
Diagram Resource
_id: (readonly) Unique diagram ID
title: Title of the diagram
my_access: (readonly) read, write, list, clone
owner: (readonly) owner ID
folder: (readonly) folder ID
#
timestamp: (readonly) creation date
modified: (readonly) boolean flag
📁
Folders
Organization API
GET /api/1/folders
list folders for a user
Response: Array of
Folder
GET /api/1/folders/:folder
get specific folder
#
Response:
Folder
Folder Resource
id: (readonly) Folder ID
name: Name of the folder
folder: (readonly) Nested folder placeholder
created_by: (readonly) creator user ID
my_access: (readonly) permissions list