Users

Supported Formats

json
>>>

GET /api/v1/users
Get all users

Supported Formats

json

Examples

GET /api/v1/users
200
[
  {
    "id": 1,
    "username": "test1",
    "receive_email": true,
    "created_at": "2016-01-07T02:07:22.000Z",
    "updated_at": "2016-01-07T02:07: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"
  },
  {
    "id": 2,
    "username": "test2",
    "receive_email": true,
    "created_at": "2016-01-07T02:07:22.000Z",
    "updated_at": "2016-01-07T02:07:22.000Z",
    "keyboard_shortcuts": false,
    "html_url": "http://www.example.com/test2",
    "avatar_url": "http://www.example.com/test2/avatar",
    "lang": {
      "code": "ja",
      "model": "lang"
    },
    "name": "test2",
    "model": "user"
  },
  {
    "id": 3,
    "username": "test",
    "receive_email": true,
    "created_at": "2016-01-07T02:07:22.000Z",
    "updated_at": "2016-01-07T02:07: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"
  },
  {
    "id": 4,
    "username": "test4",
    "receive_email": true,
    "created_at": "2016-01-07T02:07:22.000Z",
    "updated_at": "2016-01-07T02:07:22.000Z",
    "keyboard_shortcuts": false,
    "html_url": "http://www.example.com/test4",
    "avatar_url": "http://www.example.com/test4/avatar",
    "lang": {
      "code": "en",
      "model": "lang"
    },
    "name": "test4",
    "model": "user"
  },
  {
    "id": 5,
    "username": "test5",
    "receive_email": true,
    "created_at": "2016-01-07T02:07:22.000Z",
    "updated_at": "2016-01-07T02:07:22.000Z",
    "keyboard_shortcuts": false,
    "html_url": "http://www.example.com/test5",
    "avatar_url": "http://www.example.com/test5/avatar",
    "lang": {
      "code": "ja",
      "model": "lang"
    },
    "name": "test5",
    "model": "user"
  }
]
>>>

GET /api/v1/users/:username
Get a single user

Supported Formats

json

Examples

GET /api/v1/users/test
200
{
  "id": 3,
  "username": "test",
  "receive_email": true,
  "created_at": "2016-01-07T02:07:33.000Z",
  "updated_at": "2016-01-07T02:07:42.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"
}
>>>

GET /api/v1/users/:username/notes
List user notes

Supported Formats

json

Examples

GET /api/v1/users/test/notes
200
[
  {
    "id": 367,
    "is_private": false,
    "slug": "test_note",
    "title": "Test note",
    "created_at": "2016-01-07T02:07:48.000Z",
    "updated_at": "2016-01-07T02:07:49.000Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "name": "test_note",
    "team": {
      "id": 323,
      "name": "test",
      "is_default": true,
      "created_at": "2016-01-07T02:07:43.000Z",
      "updated_at": "2016-01-07T02:07: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:07:43.000Z",
          "updated_at": "2016-01-07T02:07: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"
  },
  {
    "id": 371,
    "is_private": true,
    "slug": "member_note",
    "title": "Member note",
    "created_at": "2016-01-07T02:07:52.000Z",
    "updated_at": "2016-01-07T02:07:52.000Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "name": "member_note",
    "team": {
      "id": 330,
      "name": "member",
      "is_default": false,
      "created_at": "2016-01-07T02:07:52.000Z",
      "updated_at": "2016-01-07T02:07:52.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:07:43.000Z",
          "updated_at": "2016-01-07T02:07: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"
        }
      ],
      "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": 370,
    "is_private": true,
    "slug": "manager_note",
    "title": "Manager note",
    "created_at": "2016-01-07T02:07:51.000Z",
    "updated_at": "2016-01-07T02:07:52.000Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "name": "manager_note",
    "team": {
      "id": 329,
      "name": "manager",
      "is_default": false,
      "created_at": "2016-01-07T02:07:51.000Z",
      "updated_at": "2016-01-07T02:07:52.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:07:43.000Z",
          "updated_at": "2016-01-07T02:07: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/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": 368,
    "is_private": false,
    "slug": "some_note",
    "title": "Some note",
    "created_at": "2016-01-07T02:07:49.000Z",
    "updated_at": "2016-01-07T02:07:50.000Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "name": "some_note",
    "team": {
      "id": 327,
      "name": "some",
      "is_default": false,
      "created_at": "2016-01-07T02:07:49.000Z",
      "updated_at": "2016-01-07T02:07:50.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:07:43.000Z",
          "updated_at": "2016-01-07T02:07: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"
        }
      ],
      "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"
  }
]