Notes

Supported Formats

json
>>>

GET /api/v1/notes
List team notes

Supported Formats

json

Examples

GET /api/v1/notes
200
[
  {
    "id": 468,
    "is_private": false,
    "slug": "test_note",
    "title": "Test note",
    "created_at": "2016-01-07T02:09:18.000Z",
    "updated_at": "2016-01-07T02:09:19.000Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "name": "test_note",
    "team": {
      "id": 413,
      "name": "test",
      "is_default": true,
      "created_at": "2016-01-07T02:09:13.000Z",
      "updated_at": "2016-01-07T02:09:19.000Z",
      "html_url": "http://www.example.com/test",
      "avatar_url": "http://www.example.com/test/avatar",
      "role": "manager",
      "managers": [
        {
          "id": 3,
          "username": "test",
          "receive_email": true,
          "created_at": "2016-01-07T02:09:13.000Z",
          "updated_at": "2016-01-07T02:09:22.000Z",
          "keyboard_shortcuts": false,
          "options": {
            "advanced_menu": true
          },
          "html_url": "http://www.example.com/test",
          "avatar_url": "http://www.example.com/test/avatar",
          "lang": {
            "code": "en",
            "model": "lang"
          },
          "name": "test",
          "model": "user"
        }
      ],
      "members": [],
      "plan": "micro",
      "model": "team"
    },
    "html_url": "http://www.example.com/test/test_note",
    "avatar_url": "http://www.example.com/test/test_note/avatar",
    "can_pull": false,
    "can_request": false,
    "can_manage": true,
    "description_html": "<p></p>",
    "model": "note"
  },
  {
    "id": 472,
    "is_private": true,
    "slug": "member_note",
    "title": "Member note",
    "created_at": "2016-01-07T02:09:22.000Z",
    "updated_at": "2016-01-07T02:09:23.000Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "name": "member_note",
    "team": {
      "id": 420,
      "name": "member",
      "is_default": false,
      "created_at": "2016-01-07T02:09:22.000Z",
      "updated_at": "2016-01-07T02:09:23.000Z",
      "html_url": "http://www.example.com/member",
      "avatar_url": "http://www.example.com/member/avatar",
      "role": "member",
      "managers": [],
      "members": [
        {
          "id": 3,
          "username": "test",
          "receive_email": true,
          "created_at": "2016-01-07T02:09:13.000Z",
          "updated_at": "2016-01-07T02:09:22.000Z",
          "keyboard_shortcuts": false,
          "options": {
            "advanced_menu": true
          },
          "html_url": "http://www.example.com/test",
          "avatar_url": "http://www.example.com/test/avatar",
          "lang": {
            "code": "en",
            "model": "lang"
          },
          "name": "test",
          "model": "user"
        }
      ],
      "plan": "micro",
      "model": "team"
    },
    "html_url": "http://www.example.com/member/member_note",
    "avatar_url": "http://www.example.com/member/member_note/avatar",
    "can_pull": false,
    "can_request": false,
    "can_manage": false,
    "description_html": "<p></p>",
    "model": "note"
  },
  {
    "id": 471,
    "is_private": true,
    "slug": "manager_note",
    "title": "Manager note",
    "created_at": "2016-01-07T02:09:21.000Z",
    "updated_at": "2016-01-07T02:09:22.000Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "name": "manager_note",
    "team": {
      "id": 419,
      "name": "manager",
      "is_default": false,
      "created_at": "2016-01-07T02:09:21.000Z",
      "updated_at": "2016-01-07T02:09:22.000Z",
      "html_url": "http://www.example.com/manager",
      "avatar_url": "http://www.example.com/manager/avatar",
      "role": "manager",
      "managers": [
        {
          "id": 3,
          "username": "test",
          "receive_email": true,
          "created_at": "2016-01-07T02:09:13.000Z",
          "updated_at": "2016-01-07T02:09:22.000Z",
          "keyboard_shortcuts": false,
          "options": {
            "advanced_menu": true
          },
          "html_url": "http://www.example.com/test",
          "avatar_url": "http://www.example.com/test/avatar",
          "lang": {
            "code": "en",
            "model": "lang"
          },
          "name": "test",
          "model": "user"
        }
      ],
      "members": [],
      "plan": "micro",
      "model": "team"
    },
    "html_url": "http://www.example.com/manager/manager_note",
    "avatar_url": "http://www.example.com/manager/manager_note/avatar",
    "can_pull": false,
    "can_request": false,
    "can_manage": true,
    "description_html": "<p></p>",
    "model": "note"
  },
  {
    "id": 469,
    "is_private": false,
    "slug": "some_note",
    "title": "Some note",
    "created_at": "2016-01-07T02:09:19.000Z",
    "updated_at": "2016-01-07T02:09:20.000Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "name": "some_note",
    "team": {
      "id": 417,
      "name": "some",
      "is_default": false,
      "created_at": "2016-01-07T02:09:19.000Z",
      "updated_at": "2016-01-07T02:09:20.000Z",
      "html_url": "http://www.example.com/some",
      "avatar_url": "http://www.example.com/some/avatar",
      "role": "member",
      "managers": [],
      "members": [
        {
          "id": 3,
          "username": "test",
          "receive_email": true,
          "created_at": "2016-01-07T02:09:13.000Z",
          "updated_at": "2016-01-07T02:09:22.000Z",
          "keyboard_shortcuts": false,
          "options": {
            "advanced_menu": true
          },
          "html_url": "http://www.example.com/test",
          "avatar_url": "http://www.example.com/test/avatar",
          "lang": {
            "code": "en",
            "model": "lang"
          },
          "name": "test",
          "model": "user"
        }
      ],
      "plan": "micro",
      "model": "team"
    },
    "html_url": "http://www.example.com/some/some_note",
    "avatar_url": "http://www.example.com/some/some_note/avatar",
    "can_pull": false,
    "can_request": false,
    "can_manage": false,
    "description_html": "<p></p>",
    "model": "note"
  }
]

Params

Param name Description
type
optional

Can be either all, public, private or fork. Default: all


Value:

Must be String
team
optional
Value:

Must be String
>>>

GET /api/v1/:team/:note
Get a single note

Supported Formats

json

Examples

GET /api/v1/test/test_note
200
{
  "id": 411,
  "is_private": false,
  "slug": "test_note",
  "title": "Test note",
  "created_at": "2016-01-07T02:08:28.000Z",
  "updated_at": "2016-01-07T02:08:28.000Z",
  "format": "html",
  "share": "none",
  "is_time_track": true,
  "name": "test_note",
  "team": {
    "id": 363,
    "name": "test",
    "is_default": true,
    "created_at": "2016-01-07T02:08:23.000Z",
    "updated_at": "2016-01-07T02:08:28.000Z",
    "html_url": "http://www.example.com/test",
    "avatar_url": "http://www.example.com/test/avatar",
    "role": "manager",
    "managers": [
      {
        "id": 3,
        "username": "test",
        "receive_email": true,
        "created_at": "2016-01-07T02:08:23.000Z",
        "updated_at": "2016-01-07T02:08:31.000Z",
        "keyboard_shortcuts": false,
        "options": {
          "advanced_menu": true
        },
        "html_url": "http://www.example.com/test",
        "avatar_url": "http://www.example.com/test/avatar",
        "lang": {
          "code": "en",
          "model": "lang"
        },
        "name": "test",
        "model": "user"
      }
    ],
    "members": [],
    "plan": "micro",
    "model": "team"
  },
  "html_url": "http://www.example.com/test/test_note",
  "avatar_url": "http://www.example.com/test/test_note/avatar",
  "can_pull": false,
  "can_request": false,
  "can_manage": true,
  "description_html": "<p></p>",
  "model": "note"
}
>>>

POST /api/v1/notes
Create

Supported Formats

json

Examples

POST /api/v1/notes
note%5Bteam%5D=test&note%5Btitle%5D=Test+note
200
{
  "id": 438,
  "user_id": 3,
  "is_private": true,
  "title": "Test note",
  "created_at": "2016-01-07T02:08:51.622Z",
  "updated_at": "2016-01-07T02:08:51.622Z",
  "format": "html",
  "share": "none",
  "is_time_track": true,
  "name": "438",
  "team": {
    "id": 383,
    "name": "test",
    "is_default": true,
    "created_at": "2016-01-07T02:08:41.000Z",
    "updated_at": "2016-01-07T02:08:52.177Z",
    "html_url": "http://www.example.com/test",
    "avatar_url": "http://www.example.com/test/avatar",
    "role": "manager",
    "managers": [
      {
        "id": 3,
        "username": "test",
        "receive_email": true,
        "created_at": "2016-01-07T02:08:41.000Z",
        "updated_at": "2016-01-07T02:08:50.000Z",
        "keyboard_shortcuts": false,
        "options": {
          "advanced_menu": true
        },
        "html_url": "http://www.example.com/test",
        "avatar_url": "http://www.example.com/test/avatar",
        "lang": {
          "code": "en",
          "model": "lang"
        },
        "name": "test",
        "model": "user"
      }
    ],
    "members": [],
    "plan": "micro",
    "model": "team"
  },
  "html_url": "http://www.example.com/test/438",
  "avatar_url": "http://www.example.com/test/438/avatar",
  "can_pull": false,
  "can_request": false,
  "can_manage": true,
  "description_html": "<p></p>",
  "model": "note"
}

Params

Param name Description
note
optional
Value:

Must be a Hash
note[title]
required
Value:

Must be String
note[description]
optional
Value:

Must be String
note[team]
required

Team name


Value:

Must be String
note[slug]
optional
Value:

Must be String
note[is_private]
optional
Value:

Must be one of: true, false.
>>>

PATCH /api/v1/:team/:note
Update

Supported Formats

json

Examples

PUT /api/v1/test/495
note%5Bteam%5D=test&note%5Btitle%5D=Test+note
200
{
  "id": 495,
  "user_id": 3,
  "is_private": false,
  "pulled_at": "2016-01-07T02:09:46.000Z",
  "title": "Test note",
  "created_at": "2016-01-07T02:09:48.000Z",
  "updated_at": "2016-01-07T02:09:48.581Z",
  "format": "html",
  "share": "none",
  "is_time_track": true,
  "forked": {
    "id": 490,
    "is_private": false,
    "slug": "test_note",
    "title": "Test note",
    "created_at": "2016-01-07T02:09:41.000Z",
    "updated_at": "2016-01-07T02:09:48.848Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "name": "test_note",
    "team": {
      "id": 433,
      "name": "test",
      "is_default": true,
      "created_at": "2016-01-07T02:09:35.000Z",
      "updated_at": "2016-01-07T02:09:48.850Z",
      "html_url": "http://www.example.com/test",
      "avatar_url": "http://www.example.com/test/avatar",
      "role": "manager",
      "managers": [
        {
          "id": 3,
          "username": "test",
          "receive_email": true,
          "created_at": "2016-01-07T02:09:35.000Z",
          "updated_at": "2016-01-07T02:09:45.000Z",
          "keyboard_shortcuts": false,
          "options": {
            "advanced_menu": true
          },
          "html_url": "http://www.example.com/test",
          "avatar_url": "http://www.example.com/test/avatar",
          "lang": {
            "code": "en",
            "model": "lang"
          },
          "name": "test",
          "model": "user"
        }
      ],
      "members": [],
      "plan": "micro",
      "model": "team"
    },
    "html_url": "http://www.example.com/test/test_note",
    "avatar_url": "http://www.example.com/test/test_note/avatar",
    "can_pull": false,
    "can_request": false,
    "can_manage": true,
    "description_html": "<p></p>",
    "model": "note"
  },
  "name": "495",
  "team": {
    "id": 433,
    "name": "test",
    "is_default": true,
    "created_at": "2016-01-07T02:09:35.000Z",
    "updated_at": "2016-01-07T02:09:48.847Z",
    "html_url": "http://www.example.com/test",
    "avatar_url": "http://www.example.com/test/avatar",
    "role": "manager",
    "managers": [
      {
        "id": 3,
        "username": "test",
        "receive_email": true,
        "created_at": "2016-01-07T02:09:35.000Z",
        "updated_at": "2016-01-07T02:09:45.000Z",
        "keyboard_shortcuts": false,
        "options": {
          "advanced_menu": true
        },
        "html_url": "http://www.example.com/test",
        "avatar_url": "http://www.example.com/test/avatar",
        "lang": {
          "code": "en",
          "model": "lang"
        },
        "name": "test",
        "model": "user"
      }
    ],
    "members": [],
    "plan": "micro",
    "model": "team"
  },
  "html_url": "http://www.example.com/test/495",
  "avatar_url": "http://www.example.com/test/495/avatar",
  "can_pull": false,
  "can_request": false,
  "can_manage": true,
  "description_html": "<p></p>",
  "model": "note"
}

Params

Param name Description
note
optional
Value:

Must be a Hash
note[title]
required
Value:

Must be String
note[description]
optional
Value:

Must be String
note[team]
required

Team name


Value:

Must be String
note[slug]
optional
Value:

Must be String
note[is_private]
optional
Value:

Must be one of: true, false.
>>>

DELETE /api/v1/:team/:note
Destroy

Supported Formats

json

Examples

DELETE /api/v1/test/test_note
204
>>>

GET /api/v1/:team/:note/contributors
List contributors

Supported Formats

json

Examples

GET /api/v1/test/test_note/contributors
200
[
  {
    "id": 3,
    "username": "test",
    "receive_email": true,
    "created_at": "2016-01-07T02:08:52.000Z",
    "updated_at": "2016-01-07T02:09:00.000Z",
    "keyboard_shortcuts": false,
    "options": {
      "advanced_menu": true
    },
    "html_url": "http://www.example.com/test",
    "avatar_url": "http://www.example.com/test/avatar",
    "lang": {
      "code": "en",
      "model": "lang"
    },
    "name": "test",
    "model": "user"
  }
]
>>>

POST /api/v1/:team/:note/forks
Fork

Supported Formats

json

Examples

POST /api/v1/test/test_note/forks
note%5Btitle%5D=Forked_note
200
{
  "id": 461,
  "user_id": 3,
  "is_private": false,
  "pulled_at": "2016-01-07T02:09:11.000Z",
  "title": "Copy of Test note (test)",
  "created_at": "2016-01-07T02:09:13.000Z",
  "updated_at": "2016-01-07T02:09:13.000Z",
  "format": "html",
  "share": "none",
  "is_time_track": true,
  "forked": {
    "id": 456,
    "is_private": false,
    "slug": "test_note",
    "title": "Test note",
    "created_at": "2016-01-07T02:09:07.000Z",
    "updated_at": "2016-01-07T02:09:13.000Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "name": "test_note",
    "team": {
      "id": 403,
      "name": "test",
      "is_default": true,
      "created_at": "2016-01-07T02:09:02.000Z",
      "updated_at": "2016-01-07T02:09:13.000Z",
      "html_url": "http://www.example.com/test",
      "avatar_url": "http://www.example.com/test/avatar",
      "role": "manager",
      "managers": [
        {
          "id": 3,
          "username": "test",
          "receive_email": true,
          "created_at": "2016-01-07T02:09:02.000Z",
          "updated_at": "2016-01-07T02:09:10.000Z",
          "keyboard_shortcuts": false,
          "options": {
            "advanced_menu": true
          },
          "html_url": "http://www.example.com/test",
          "avatar_url": "http://www.example.com/test/avatar",
          "lang": {
            "code": "en",
            "model": "lang"
          },
          "name": "test",
          "model": "user"
        }
      ],
      "members": [],
      "plan": "micro",
      "model": "team"
    },
    "html_url": "http://www.example.com/test/test_note",
    "avatar_url": "http://www.example.com/test/test_note/avatar",
    "can_pull": false,
    "can_request": false,
    "can_manage": true,
    "description_html": "<p></p>",
    "model": "note"
  },
  "name": "461",
  "team": {
    "id": 403,
    "name": "test",
    "is_default": true,
    "created_at": "2016-01-07T02:09:02.000Z",
    "updated_at": "2016-01-07T02:09:13.000Z",
    "html_url": "http://www.example.com/test",
    "avatar_url": "http://www.example.com/test/avatar",
    "role": "manager",
    "managers": [
      {
        "id": 3,
        "username": "test",
        "receive_email": true,
        "created_at": "2016-01-07T02:09:02.000Z",
        "updated_at": "2016-01-07T02:09:10.000Z",
        "keyboard_shortcuts": false,
        "options": {
          "advanced_menu": true
        },
        "html_url": "http://www.example.com/test",
        "avatar_url": "http://www.example.com/test/avatar",
        "lang": {
          "code": "en",
          "model": "lang"
        },
        "name": "test",
        "model": "user"
      }
    ],
    "members": [],
    "plan": "micro",
    "model": "team"
  },
  "html_url": "http://www.example.com/test/461",
  "avatar_url": "http://www.example.com/test/461/avatar",
  "can_pull": false,
  "can_request": false,
  "can_manage": true,
  "description_html": "<p></p>",
  "model": "note"
}

Params

Param name Description
title
optional
Value:

Must be String
>>>

GET /api/v1/:team/:note/comments
List comments

Supported Formats

json

Examples

GET /api/v1/test/test_note/comments
200
[
  {
    "id": 4,
    "comment": "Test comment",
    "user_id": 3,
    "created_at": "2016-01-07T02:08:23.000Z",
    "updated_at": "2016-01-07T02:08:23.000Z",
    "user": {
      "id": 3,
      "username": "test",
      "receive_email": true,
      "created_at": "2016-01-07T02:08:13.000Z",
      "updated_at": "2016-01-07T02:08:21.000Z",
      "keyboard_shortcuts": false,
      "options": {
        "advanced_menu": true
      },
      "html_url": "http://www.example.com/test",
      "avatar_url": "http://www.example.com/test/avatar",
      "lang": {
        "code": "en",
        "model": "lang"
      },
      "name": "test",
      "model": "user"
    },
    "mentions": [
      {
        "id": 1,
        "username": "test1",
        "receive_email": true,
        "created_at": "2016-01-07T02:08:13.000Z",
        "updated_at": "2016-01-07T02:08:23.000Z",
        "keyboard_shortcuts": false,
        "html_url": "http://www.example.com/test1",
        "avatar_url": "http://www.example.com/test1/avatar",
        "lang": {
          "code": "ja",
          "model": "lang"
        },
        "name": "test1",
        "model": "user"
      }
    ],
    "can_delete": true,
    "type": "note",
    "note": {
      "id": 400,
      "is_private": false,
      "slug": "test_note",
      "title": "Test note",
      "created_at": "2016-01-07T02:08:18.000Z",
      "updated_at": "2016-01-07T02:08:23.000Z",
      "format": "html",
      "share": "none",
      "is_time_track": true,
      "name": "test_note",
      "team": {
        "id": 353,
        "name": "test",
        "is_default": true,
        "created_at": "2016-01-07T02:08:13.000Z",
        "updated_at": "2016-01-07T02:08:23.000Z",
        "html_url": "http://www.example.com/test",
        "avatar_url": "http://www.example.com/test/avatar",
        "role": "manager",
        "managers": [
          {
            "id": 3,
            "username": "test",
            "receive_email": true,
            "created_at": "2016-01-07T02:08:13.000Z",
            "updated_at": "2016-01-07T02:08:21.000Z",
            "keyboard_shortcuts": false,
            "options": {
              "advanced_menu": true
            },
            "html_url": "http://www.example.com/test",
            "avatar_url": "http://www.example.com/test/avatar",
            "lang": {
              "code": "en",
              "model": "lang"
            },
            "name": "test",
            "model": "user"
          }
        ],
        "members": [],
        "plan": "micro",
        "model": "team"
      },
      "html_url": "http://www.example.com/test/test_note",
      "avatar_url": "http://www.example.com/test/test_note/avatar",
      "can_pull": false,
      "can_request": false,
      "can_manage": true,
      "description_html": "<p></p>",
      "model": "note"
    },
    "model": "comment"
  }
]
>>>

POST /api/v1/:team/:note/comments
Create comment

Supported Formats

json

Examples

POST /api/v1/test/test_note/comments
comment%5Bcomment%5D=Test+comment&mentions%5B%5D=test1
200
{
  "id": 5,
  "comment": "Test comment",
  "user_id": 3,
  "created_at": "2016-01-07T02:08:41.701Z",
  "updated_at": "2016-01-07T02:08:41.701Z",
  "user": {
    "id": 3,
    "username": "test",
    "receive_email": true,
    "created_at": "2016-01-07T02:08:32.000Z",
    "updated_at": "2016-01-07T02:08:40.000Z",
    "keyboard_shortcuts": false,
    "options": {
      "advanced_menu": true
    },
    "html_url": "http://www.example.com/test",
    "avatar_url": "http://www.example.com/test/avatar",
    "lang": {
      "code": "en",
      "model": "lang"
    },
    "name": "test",
    "model": "user"
  },
  "mentions": [
    {
      "id": 1,
      "username": "test1",
      "receive_email": true,
      "created_at": "2016-01-07T02:08:32.000Z",
      "updated_at": "2016-01-07T02:08:41.000Z",
      "keyboard_shortcuts": false,
      "html_url": "http://www.example.com/test1",
      "avatar_url": "http://www.example.com/test1/avatar",
      "lang": {
        "code": "ja",
        "model": "lang"
      },
      "name": "test1",
      "model": "user"
    }
  ],
  "can_delete": true,
  "type": "note",
  "note": {
    "id": 422,
    "is_private": false,
    "slug": "test_note",
    "title": "Test note",
    "created_at": "2016-01-07T02:08:37.000Z",
    "updated_at": "2016-01-07T02:08:41.712Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "name": "test_note",
    "team": {
      "id": 373,
      "name": "test",
      "is_default": true,
      "created_at": "2016-01-07T02:08:32.000Z",
      "updated_at": "2016-01-07T02:08:41.713Z",
      "html_url": "http://www.example.com/test",
      "avatar_url": "http://www.example.com/test/avatar",
      "role": "manager",
      "managers": [
        {
          "id": 3,
          "username": "test",
          "receive_email": true,
          "created_at": "2016-01-07T02:08:32.000Z",
          "updated_at": "2016-01-07T02:08:40.000Z",
          "keyboard_shortcuts": false,
          "options": {
            "advanced_menu": true
          },
          "html_url": "http://www.example.com/test",
          "avatar_url": "http://www.example.com/test/avatar",
          "lang": {
            "code": "en",
            "model": "lang"
          },
          "name": "test",
          "model": "user"
        }
      ],
      "members": [],
      "plan": "micro",
      "model": "team"
    },
    "html_url": "http://www.example.com/test/test_note",
    "avatar_url": "http://www.example.com/test/test_note/avatar",
    "can_pull": false,
    "can_request": false,
    "can_manage": true,
    "description_html": "<p></p>",
    "model": "note"
  },
  "model": "comment"
}

Params

Param name Description
comment
optional
Value:

Must be a Hash
comment[comment]
required
Value:

Must be String
mentions
optional

Usernames


Value:

Must be an array of String
>>>

DELETE /api/v1/:team/:note/comments/:id
Destroy comment

Supported Formats

json

Examples

DELETE /api/v1/test/test_note/comments/6
204
>>>

GET /api/v1/:team/:note/tags
List tags

Supported Formats

json

Examples

GET /api/v1/test/test_note/tags
200
[
  {
    "html_url": "http://www.example.com/test/test_note/issues?tag=tag1",
    "name": "tag1"
  },
  {
    "html_url": "http://www.example.com/test/test_note/issues?tag=tag2",
    "name": "tag2"
  }
]
>>>

GET /api/v1/:team/:note/hooks
List hooks

Supported Formats

json
>>>

POST /api/v1/:team/:note/hooks
Create hook

Supported Formats

json

Params

Param name Description
hook
optional
Value:

Must be a Hash
hook[name]
required
Value:

Must be String
hook[events]
required

start_issue, stop_issue, new_comment, merge, update_page


Value:

Must be an array of any type
>>>

DELETE /api/v1/:team/:note/hooks/:id
Destroy hook

Supported Formats

json