Notifications

Supported Formats

json
>>>

GET /api/v1/notifications
List notifications

Supported Formats

json

Examples

GET /api/v1/notifications
200
[
  {
    "id": 4,
    "event": "new_note",
    "is_read": false,
    "created_at": "2016-01-07T02:03:16.000Z",
    "updated_at": "2016-01-07T02:03:16.000Z",
    "from_user": {
      "id": 1,
      "username": "test1",
      "receive_email": true,
      "created_at": "2016-01-07T02:03:07.000Z",
      "updated_at": "2016-01-07T02:03:07.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"
    },
    "note": {
      "id": 89,
      "is_private": false,
      "slug": "help_en",
      "title": "Help",
      "created_at": "2016-01-07T02:03:07.000Z",
      "updated_at": "2016-01-07T02:03:07.000Z",
      "format": "html",
      "share": "none",
      "is_time_track": true,
      "name": "help_en",
      "team": {
        "id": 86,
        "name": "ruffnote",
        "fullname": "Ruffnote",
        "url": "https://ruffnote.com/",
        "description": "Documatation better, freely.",
        "is_default": false,
        "created_at": "2016-01-07T02:03:07.000Z",
        "updated_at": "2016-01-07T02:03:11.000Z",
        "html_url": "http://www.example.com/ruffnote",
        "avatar_url": "http://www.example.com/ruffnote/avatar",
        "managers": [
          {
            "id": 1,
            "username": "test1",
            "receive_email": true,
            "created_at": "2016-01-07T02:03:07.000Z",
            "updated_at": "2016-01-07T02:03:07.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:03:07.000Z",
            "updated_at": "2016-01-07T02:03:07.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": 4,
            "username": "test4",
            "receive_email": true,
            "created_at": "2016-01-07T02:03:07.000Z",
            "updated_at": "2016-01-07T02:03:07.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:03:07.000Z",
            "updated_at": "2016-01-07T02:03:07.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"
          }
        ],
        "members": [],
        "plan": "small",
        "model": "team"
      },
      "html_url": "http://www.example.com/ruffnote/help_en",
      "avatar_url": "http://www.example.com/ruffnote/help_en/avatar",
      "can_pull": false,
      "can_request": false,
      "can_manage": false,
      "description_html": "<p></p>",
      "model": "note"
    },
    "title": "test1 created ruffnote - Help.",
    "time_ago": "less than a minute ago",
    "type": "note",
    "model": "notification"
  }
]

Params

Param name Description
state
optional

Can be either unread, read or all. Default: unread


Value:

Must be String
page
optional
Value:

Must be a number.
team
optional

Team name


Value:

Must be String
>>>

PATCH /api/v1/notifications/:id
Toggle

Supported Formats

json

Examples

PUT /api/v1/notifications/5

200
{
  "id": 5,
  "event": "new_note",
  "is_read": true,
  "created_at": "2016-01-07T02:03:27.000Z",
  "updated_at": "2016-01-07T02:03:27.836Z",
  "from_user": {
    "id": 1,
    "username": "test1",
    "receive_email": true,
    "created_at": "2016-01-07T02:03:16.000Z",
    "updated_at": "2016-01-07T02:03:17.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"
  },
  "note": {
    "id": 100,
    "is_private": false,
    "slug": "help_en",
    "title": "Help",
    "created_at": "2016-01-07T02:03:17.000Z",
    "updated_at": "2016-01-07T02:03:17.000Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "name": "help_en",
    "team": {
      "id": 96,
      "name": "ruffnote",
      "fullname": "Ruffnote",
      "url": "https://ruffnote.com/",
      "description": "Documatation better, freely.",
      "is_default": false,
      "created_at": "2016-01-07T02:03:17.000Z",
      "updated_at": "2016-01-07T02:03:21.000Z",
      "html_url": "http://www.example.com/ruffnote",
      "avatar_url": "http://www.example.com/ruffnote/avatar",
      "managers": [
        {
          "id": 1,
          "username": "test1",
          "receive_email": true,
          "created_at": "2016-01-07T02:03:16.000Z",
          "updated_at": "2016-01-07T02:03:17.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:03:16.000Z",
          "updated_at": "2016-01-07T02:03:17.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": 4,
          "username": "test4",
          "receive_email": true,
          "created_at": "2016-01-07T02:03:17.000Z",
          "updated_at": "2016-01-07T02:03:17.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:03:17.000Z",
          "updated_at": "2016-01-07T02:03:17.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"
        }
      ],
      "members": [],
      "plan": "small",
      "model": "team"
    },
    "html_url": "http://www.example.com/ruffnote/help_en",
    "avatar_url": "http://www.example.com/ruffnote/help_en/avatar",
    "can_pull": false,
    "can_request": false,
    "can_manage": false,
    "description_html": "<p></p>",
    "model": "note"
  },
  "title": "test1 created ruffnote - Help.",
  "time_ago": "less than a minute ago",
  "type": "note",
  "model": "notification"
}