Welcome

Supported Formats

json
>>>

GET /api/v1/logs
Get user logs

Supported Formats

json

Examples

GET /api/v1/logs
200
[
  {
    "id": 1,
    "user_id": 3,
    "created_at": "2016-01-07T02:06:54.000Z",
    "updated_at": "2016-01-07T02:06:54.000Z",
    "user": {
      "id": 3,
      "username": "test",
      "receive_email": true,
      "created_at": "2016-01-07T02:06:43.000Z",
      "updated_at": "2016-01-07T02:06:52.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"
    },
    "time_ago": "less than a minute ago",
    "type": "note",
    "note": {
      "id": 301,
      "is_private": false,
      "slug": "test_note",
      "title": "Test note",
      "created_at": "2016-01-07T02:06:48.000Z",
      "updated_at": "2016-01-07T02:06:49.000Z",
      "format": "html",
      "share": "none",
      "is_time_track": true,
      "name": "test_note",
      "team": {
        "id": 263,
        "name": "test",
        "is_default": true,
        "created_at": "2016-01-07T02:06:43.000Z",
        "updated_at": "2016-01-07T02:06:49.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:43.000Z",
            "updated_at": "2016-01-07T02:06:52.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": "log"
  }
]
>>>

GET /api/v1/my_issues
Get user issues

Supported Formats

json

Examples

GET /api/v1/my_issues
200
[
  {
    "id": 1,
    "title": "Test issue",
    "is_done": false,
    "index": 1,
    "created_at": "2016-01-07T02:07:04.000Z",
    "updated_at": "2016-01-07T02:07:04.000Z",
    "position": 1,
    "rate": 0,
    "to_user": {
      "id": 3,
      "username": "test",
      "receive_email": true,
      "created_at": "2016-01-07T02:06:55.000Z",
      "updated_at": "2016-01-07T02:07:04.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"
    },
    "from_user": {
      "id": 3,
      "username": "test",
      "receive_email": true,
      "created_at": "2016-01-07T02:06:55.000Z",
      "updated_at": "2016-01-07T02:07:04.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"
    },
    "note": {
      "id": 312,
      "is_private": false,
      "slug": "test_note",
      "title": "Test note",
      "created_at": "2016-01-07T02:07:00.000Z",
      "updated_at": "2016-01-07T02:07:04.000Z",
      "format": "html",
      "share": "none",
      "is_time_track": true,
      "name": "test_note",
      "team": {
        "id": 273,
        "name": "test",
        "is_default": true,
        "created_at": "2016-01-07T02:06:55.000Z",
        "updated_at": "2016-01-07T02:07:04.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:55.000Z",
            "updated_at": "2016-01-07T02:07:04.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"
    },
    "label": "Issue #1 Test issue",
    "html_url": "http://www.example.com/test/test_note/issues/1",
    "can_manage": true,
    "tags": [],
    "description_html": "<p></p>",
    "model": "issue"
  }
]

Params

Param name Description
state
optional

Can be either open, closed or all. Default: open


Value:

Must be String
>>>

GET /api/v1/checks
Get user checks

Supported Formats

json

Examples

GET /api/v1/checks?type=pull
200
[
  {
    "id": 294,
    "user_id": 3,
    "is_private": false,
    "pulled_at": "2016-01-07T02:06:40.000Z",
    "title": "Copy of Test note (test)",
    "created_at": "2016-01-07T02:06:41.000Z",
    "updated_at": "2016-01-07T02:06:41.000Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "forked": {
      "id": 289,
      "is_private": false,
      "slug": "test_note",
      "title": "Test note",
      "created_at": "2016-01-07T02:06:35.000Z",
      "updated_at": "2016-01-07T02:06:43.000Z",
      "format": "html",
      "share": "none",
      "is_time_track": true,
      "name": "test_note",
      "team": {
        "id": 253,
        "name": "test",
        "is_default": true,
        "created_at": "2016-01-07T02:06:29.000Z",
        "updated_at": "2016-01-07T02:06:43.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:29.000Z",
            "updated_at": "2016-01-07T02:06:39.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": "294",
    "team": {
      "id": 253,
      "name": "test",
      "is_default": true,
      "created_at": "2016-01-07T02:06:29.000Z",
      "updated_at": "2016-01-07T02:06:43.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:29.000Z",
          "updated_at": "2016-01-07T02:06:39.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/294",
    "avatar_url": "http://www.example.com/test/294/avatar",
    "can_pull": true,
    "can_request": false,
    "can_manage": true,
    "description_html": "<p></p>",
    "model": "note"
  }
]

Params

Param name Description
type
optional

Can be either merge, request or pull. Default: merge


Value:

Must be String
>>>

GET /api/v1/search
Search user notes

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
>>>

GET /api/v1/usernames
List all usernames

Supported Formats

json

Examples

GET /api/v1/usernames
200
[
  "test",
  "test1",
  "test2",
  "test4",
  "test5"
]