Pages

Supported Formats

json
>>>

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

Supported Formats

json

Examples

GET /api/v1/test/test_note/pages
200
{
  "pages": [
    {
      "id": 153,
      "title": "Test page",
      "created_at": "2016-01-07T02:03:03.000Z",
      "updated_at": "2016-01-07T02:03:03.000Z",
      "is_cover": false,
      "note": {
        "id": 84,
        "is_private": false,
        "slug": "test_note",
        "title": "Test note",
        "created_at": "2016-01-07T02:03:02.000Z",
        "updated_at": "2016-01-07T02:03:03.000Z",
        "format": "html",
        "share": "none",
        "is_time_track": true,
        "name": "test_note",
        "team": {
          "id": 73,
          "name": "test",
          "is_default": true,
          "created_at": "2016-01-07T02:02:58.000Z",
          "updated_at": "2016-01-07T02:03:03.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:02:58.000Z",
              "updated_at": "2016-01-07T02:03:06.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"
      },
      "html_url": "http://www.example.com/test/test_note/153",
      "content": "Test content",
      "path": "Test page",
      "children": [],
      "model": "page"
    }
  ],
  "last_page": true
}

Params

Param name Description
parent
optional

Can be either root or :page_id. Default: root


Value:

Must be String
page
optional

Specify page of results. Results will be paginated to 20 items.


Value:

Must be a number.
order
optional

Can be either alphabet_asc, alphabet_desc, newer or older. Default: alphabet_asc


Value:

Must be String
>>>

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

Supported Formats

json

Examples

GET /api/v1/test/test_note/32
200
{
  "id": 32,
  "title": "Test page",
  "created_at": "2016-01-07T02:02:08.000Z",
  "updated_at": "2016-01-07T02:02:08.000Z",
  "is_cover": false,
  "note": {
    "id": 18,
    "is_private": false,
    "slug": "test_note",
    "title": "Test note",
    "created_at": "2016-01-07T02:02:08.000Z",
    "updated_at": "2016-01-07T02:02:08.000Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "name": "test_note",
    "team": {
      "id": 13,
      "name": "test",
      "is_default": true,
      "created_at": "2016-01-07T02:02:03.000Z",
      "updated_at": "2016-01-07T02:02:08.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:02:03.000Z",
          "updated_at": "2016-01-07T02:02:11.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"
  },
  "html_url": "http://www.example.com/test/test_note/32",
  "content": "Test content",
  "path": "Test page",
  "children": [],
  "model": "page"
}
>>>

POST /api/v1/:team/:note/pages
Create

Supported Formats

json

Examples

POST /api/v1/test/test_note/pages
page%5Bcontent%5D=Test+content&page%5Bparent%5D=92&page%5Btitle%5D=Test+page
200
{
  "id": 101,
  "title": "Test page",
  "created_at": "2016-01-07T02:02:39.786Z",
  "updated_at": "2016-01-07T02:02:39.786Z",
  "is_cover": false,
  "note": {
    "id": 51,
    "is_private": false,
    "slug": "test_note",
    "title": "Test note",
    "created_at": "2016-01-07T02:02:35.000Z",
    "updated_at": "2016-01-07T02:02:39.792Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "name": "test_note",
    "team": {
      "id": 43,
      "name": "test",
      "is_default": true,
      "created_at": "2016-01-07T02:02:31.000Z",
      "updated_at": "2016-01-07T02:02:39.793Z",
      "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:02:31.000Z",
          "updated_at": "2016-01-07T02:02:38.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"
  },
  "html_url": "http://www.example.com/test/test_note/101",
  "content": "Test content",
  "path": "Test page / Test page",
  "children": [],
  "parent": {
    "id": 92,
    "title": "Test page",
    "created_at": "2016-01-07T02:02:36.000Z",
    "updated_at": "2016-01-07T02:02:39.794Z",
    "is_cover": false,
    "note": {
      "id": 51,
      "is_private": false,
      "slug": "test_note",
      "title": "Test note",
      "created_at": "2016-01-07T02:02:35.000Z",
      "updated_at": "2016-01-07T02:02:39.792Z",
      "format": "html",
      "share": "none",
      "is_time_track": true,
      "name": "test_note",
      "team": {
        "id": 43,
        "name": "test",
        "is_default": true,
        "created_at": "2016-01-07T02:02:31.000Z",
        "updated_at": "2016-01-07T02:02:39.793Z",
        "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:02:31.000Z",
            "updated_at": "2016-01-07T02:02:38.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"
    },
    "html_url": "http://www.example.com/test/test_note/92",
    "content": "Test content",
    "path": "Test page",
    "model": "page"
  },
  "model": "page"
}

Params

Param name Description
page
required
Value:

Must be a Hash
page[title]
required
Value:

Must be String
page[content]
required
Value:

Must be String
page[parent]
optional , nil allowed
Value:

Must be a number.
>>>

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

Supported Formats

json

Examples

PUT /api/v1/test/test_note/133
page%5Bcontent%5D=Edited+content&page%5Btitle%5D=Edited+page
200
{
  "id": 133,
  "title": "Edited page",
  "created_at": "2016-01-07T02:02:53.000Z",
  "updated_at": "2016-01-07T02:02:57.744Z",
  "is_cover": false,
  "note": {
    "id": 73,
    "is_private": false,
    "slug": "test_note",
    "title": "Test note",
    "created_at": "2016-01-07T02:02:53.000Z",
    "updated_at": "2016-01-07T02:02:58.052Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "name": "test_note",
    "team": {
      "id": 63,
      "name": "test",
      "is_default": true,
      "created_at": "2016-01-07T02:02:49.000Z",
      "updated_at": "2016-01-07T02:02:58.053Z",
      "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:02:49.000Z",
          "updated_at": "2016-01-07T02:02:56.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"
  },
  "html_url": "http://www.example.com/test/test_note/133",
  "content": "Edited content",
  "path": "Edited page",
  "children": [],
  "model": "page"
}

Params

Param name Description
page
required
Value:

Must be a Hash
page[title]
optional
Value:

Must be String
page[content]
optional
Value:

Must be String
page[parent]
optional , nil allowed
Value:

Must be a number.
>>>

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

Supported Formats

json

Examples

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

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

Supported Formats

json

Examples

GET /api/v1/test/test_note/52/comments
200
[
  {
    "id": 2,
    "comment": "Test comment",
    "user_id": 3,
    "created_at": "2016-01-07T02:02:22.000Z",
    "updated_at": "2016-01-07T02:02:22.000Z",
    "user": {
      "id": 3,
      "username": "test",
      "receive_email": true,
      "created_at": "2016-01-07T02:02:12.000Z",
      "updated_at": "2016-01-07T02:02: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:02:12.000Z",
        "updated_at": "2016-01-07T02:02:22.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": "page",
    "page": {
      "id": 52,
      "title": "Test page",
      "created_at": "2016-01-07T02:02:18.000Z",
      "updated_at": "2016-01-07T02:02:22.000Z",
      "is_cover": false,
      "note": {
        "id": 29,
        "is_private": false,
        "slug": "test_note",
        "title": "Test note",
        "created_at": "2016-01-07T02:02:18.000Z",
        "updated_at": "2016-01-07T02:02:22.000Z",
        "format": "html",
        "share": "none",
        "is_time_track": true,
        "name": "test_note",
        "team": {
          "id": 23,
          "name": "test",
          "is_default": true,
          "created_at": "2016-01-07T02:02:12.000Z",
          "updated_at": "2016-01-07T02:02:22.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:02:12.000Z",
              "updated_at": "2016-01-07T02:02: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"
      },
      "html_url": "http://www.example.com/test/test_note/52",
      "content": "Test content",
      "path": "Test page",
      "children": [],
      "model": "page"
    },
    "model": "comment"
  }
]
>>>

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

Supported Formats

json

Examples

POST /api/v1/test/test_note/12/comments
comment%5Bcomment%5D=Test+comment&mentions%5B%5D=test1
200
{
  "id": 1,
  "comment": "Test comment",
  "user_id": 3,
  "created_at": "2016-01-07T02:02:02.381Z",
  "updated_at": "2016-01-07T02:02:02.381Z",
  "user": {
    "id": 3,
    "username": "test",
    "receive_email": true,
    "created_at": "2016-01-07T02:01:50.000Z",
    "updated_at": "2016-01-07T02:02: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"
  },
  "mentions": [
    {
      "id": 1,
      "username": "test1",
      "receive_email": true,
      "created_at": "2016-01-07T02:01:50.000Z",
      "updated_at": "2016-01-07T02:02:02.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": "page",
  "page": {
    "id": 12,
    "title": "Test page",
    "created_at": "2016-01-07T02:01:57.000Z",
    "updated_at": "2016-01-07T02:02:02.395Z",
    "is_cover": false,
    "note": {
      "id": 7,
      "is_private": false,
      "slug": "test_note",
      "title": "Test note",
      "created_at": "2016-01-07T02:01:56.000Z",
      "updated_at": "2016-01-07T02:02:02.396Z",
      "format": "html",
      "share": "none",
      "is_time_track": true,
      "name": "test_note",
      "team": {
        "id": 3,
        "name": "test",
        "is_default": true,
        "created_at": "2016-01-07T02:01:50.000Z",
        "updated_at": "2016-01-07T02:02:02.396Z",
        "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:01:50.000Z",
            "updated_at": "2016-01-07T02:02: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"
          }
        ],
        "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"
    },
    "html_url": "http://www.example.com/test/test_note/12",
    "content": "Test content",
    "path": "Test page",
    "children": [],
    "model": "page"
  },
  "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/:id/comments/:id
Destroy comment

Supported Formats

json

Examples

DELETE /api/v1/test/test_note/113/comments/3
204