Please enable JavaScript.
Coggle requires JavaScript to display documents.
Coggle API Documentation - Coggle Diagram
Coggle API Documentation
-
Authentication
OAuth2
OAuth2 allows your app to securely authenticate users and act on their behalf within Coggle. Google has a good overview of OAuth2 for anyone unfamiliar with the flow.
-
OAuth2
POST /token
Once you’ve got a code
(from the consent page) you must post to
this endpoint to exchange it for an access
token.
-
-
HTTP Header: Content-Type
The content type must be application/json. The
rest of these fields should be POSTed
as properties of a JSON object in the request body:
redirect_uri
The redirect URI that you have specified on your Developer page.
Note: This must match the value specified exactly or your request will fail!
HTTP Header: Authorization
Pass your client_id and client_secret
using the standard Basic Auth
mechanism
-
GET /dialog/authorize
This is the consent page that you must redirect your user in order for them to grant your app an access token.
?scope
A space separated list of Scopes
?client_id
The client ID of your application from your
Developer page
-
?redirect_uri
The redirect URI that you have specified on your Developer page.
Note: This must match the value specified exactly or your request will fail!
Note: Once a code is granted, it is only
valid for 2 minutes, so immediately
exchange the code for an access token.
scopes
-
write
Gives your app permission to create, edit, and delete diagrams from a user's account.
User Badge
Once authenticated, you can get a persistent information "badge" for the authenticated user. The data returned includes a user ID that depends on your client ID.
-
Folders
Each diagram may belong to a
folder, allowing access for the
members of the folder
-
Folder Resource
-
-
-
-
my_access: (readonly) Array of permissions on the folder for the current user (read, write, list, clone, admin)
-
Diagrams
(aka Coggles), accessible in the browser at
https://coggle.it/diagram/:diagram
-
-
-
Diagram Resource
_id: (readonly) The ID of the diagram, use this in URLs to refer to the diagram
-
-
my_access: (readonly) Array of permissions on the diagram for the current user (read, write, list, clone)
-
folder: (readonly) The ID of the folder, or null if the diagram is not in a folder
-