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