Diagrams

Returns a list of your diagrams

Method

GET

URL

https://cacoo.com/api/v1/diagrams.format
Example : https://cacoo.com/api/v1/diagrams.json

Format

json, xml

Authentication

required

Parameters

Parameter Name	Type	Content	Default	Example
organizationKey (Required)	String	Organization Key from the Organizations API		abcdefghij
offset	Integer	Offset		0
limit	Integer	Limit		50
type	String	Type of diagrams all - All diagrams own - Owned by user shared - Shared with user stencil - Stencil template - Template recyclebin - Recycle Bin	all	own
sortOn	String	Order by updated - Updated date title - Title owner - Owner folder - Folder	updated	title
sortType	String	Order type desc - Descending order asc - Ascending order	desc	asc
folderId	Integer	Folder ID		10003
keyword	String	Search keyword		Sitemap

*If you are using a legacy plan (i.e. the old Free Plan or Plus Plan), you do not need to add organizationKey to the parameters.

Response

Field	Type	Description	Example
result	Array	Array of information about the diagrams	-
+ url	String	Public URL for Diagram	https://cacoo.com/diagrams/00e77f4dc9973517
+ imageUrl	String	URL of the first image	https://cacoo.com/diagrams/00e77f4dc9973517.png
+ imageUrlForApi	String	String to interact with the image using the API	https://cacoo.com/api/v1/diagrams/00e77f4dc9973517.png
+ diagramId	String	Diagram ID	00e77f4dc9973517
+ title	String	Title of Diagram	Wireframe
+ description	String	Diagram description	Current project wireframe
+ security	String	Security status of the diagram private - only viewable with shared users url - visible to anyone who knows the URL. public - anyone who knows the URL will be able to edit this diagram.	url
+ type	String	Type of the diagram normal - Ordinary diagram stencil - Stencil template - Template	normal
+ ownerName(Deprecated)	String	Owner’s user name	1MUJPfNEEeVUox15
+ ownerNickname(Deprecated)	String	Owner’s nick name	Yoko
+ owner	Object	Owner’s	-
+ name	String	User name	1MUJPfNEEeVUox15
+ nickname	String	Nick name	Yoko
+ type	String	Account Type cacoo - Manage authentication on Cacoo. other - Manage authentication on other than Cacoo.	cacoo
+ imageUrl	String	User Icon URL(32x32 pixels)	https://cacoo.com/account/1MUJPfNEEeVUox15/image/32x32
+ editing	Boolean	Is the diagram currently being edited?	true
+ own	Boolean	Is this a diagram you created?	true
+ shared	Boolean	Is this a diagram that has been shared with you?	false
+ folderId	Integer	ID of the folder the diagram is in	10001
+ folderName	String	Name of the folder the diagram is in	Design
+ sheetCount	Integer	Number of sheets in the diagram	3
+ created	Date	Date Created(RFC2822)	Mon, 10 Aug 2009 17:00:00 +0900
+ updated	Date	Date last updated(RFC2822)	Mon, 10 Aug 2009 17:00:00 +0900
count	Integer	Number of results	85

JSON Response Example

{
    "result": [
        {
            "url": "https://cacoo.com/diagrams/00e77f4dc9973517",
            "imageUrl": "https://cacoo.com/diagrams/00e77f4dc9973517.png",
            "imageUrlForApi": "https://cacoo.com/api/v1/diagrams/00e77f4dc9973517.png",
            "diagramId": "00e77f4dc9973517",
            "title": "Wireframe",
            "description": "Current project wireframe",
            "security": "url",
            "type": "normal",
            "ownerName": "1MUJPfNEEeVUox15",
            "ownerNickname": "Yoko",
            "owner": {
                "name": "1MUJPfNEEeVUox15",
                "nickname": "Yoko",
                "type": "cacoo",
                "imageUrl": "https://cacoo.com/account/1MUJPfNEEeVUox15/image/32x32"
            },
            "editing": true,
            "own": true,
            "shared": false,
            "folderId": 10001,
            "folderName": "Design",
            "sheetCount": 3,
            "created": "Mon, 10 Aug 2009 17:00:00 +0900",
            "updated": "Mon, 10 Aug 2009 17:00:00 +0900"
        },
        {
            // ...
        }
    ],
    "count": 85
}

XML Response Example

<?xml version="1.0" encoding="utf-8"?>
<diagrams>
  <result>
    <diagram>
      <url>https://cacoo.com/diagrams/00e77f4dc9973517</url>
      <imageUrl>https://cacoo.com/diagrams/00e77f4dc9973517.png</imageUrl>
      <imageUrlForApi>https://cacoo.com/api/v1/diagrams/00e77f4dc9973517.png</imageUrlForApi>
      <diagramId>00e77f4dc9973517</diagramId>
      <title>Wireframe</title>
      <description>Current project wireframe</description>
      <security>url</security>
      <type>normal</type>
      <ownerName>1MUJPfNEEeVUox15</ownerName>
      <ownerNickname>Yoko</ownerNickname>
      <owner>
        <name>1MUJPfNEEeVUox15</name>
        <nickname>Yoko</nickname>
        <type>cacoo</type>
        <imageUrl>https://cacoo.com/account/1MUJPfNEEeVUox15/image/32x32</imageUrl>
      </owner>
      <editing>true</editing>
      <own>true</own>
      <shared>false</shared>
      <folderId>10001</folderId>
      <folderName>Design</folderName>
      <sheetCount>3</sheetCount>
      <created>Mon, 10 Aug 2009 17:00:00 +0900</created>
      <updated>Mon, 10 Aug 2009 17:00:00 +0900</updated>
    </diagram>
    <diagram>
         ...
    </diagram>
  </result>
  <count>85</count>
</diagrams>