Supported Formats

json

Examples

GET /api/v1/search?q=test
200
[
  {
    "id": 278,
    "is_private": false,
    "slug": "test_note",
    "title": "Test note",
    "created_at": "2016-01-07T02:06:24.000Z",
    "updated_at": "2016-01-07T02:06:25.000Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "name": "test_note",
    "team": {
      "id": 243,
      "name": "test",
      "is_default": true,
      "created_at": "2016-01-07T02:06:19.000Z",
      "updated_at": "2016-01-07T02:06:25.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:06:19.000Z",
          "updated_at": "2016-01-07T02:06:28.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"
  }
]

Params

Param name Description
q
required

Value:

Must be String

order
optional

Can be either newer or older. Default: newer


Value:

Must be String

type
optional

Can be either all, page, note, issue, note_issue or note_title. Default: all


Value:

Must be String

note_id
optional

Value:

Must be Integer