Skip to content
epicmonkey edited this page Jun 14, 2015 · 7 revisions

For API examples you can follow this page.

Attachments

  • POST /v1/attachments - upload attachment

Timeline

  • GET /v1/timeline/:username - returns all posts from user
  • GET /v1/timeline/:username/likes - returns all posts that user has liked
  • GET /v1/timeline/:username/comments - returns all posts that user has commented on
  • GET /v1/timeline/home - returns river of news for auth user
  • GET /v1/timeline/filter/discussions - returns likes and comments timelines

Posts

  • GET /v1/posts/:postId
  • DELETE /v1/posts/:postId
  • PUT /v1/posts/:postId
  • POST /v1/posts
  • POST /v1/posts/:postId/like
  • POST /v1/posts/:postId/unlike
  • POST /v1/posts/:postId/hide
  • POST /v1/posts/:postId/unhide

Comments

  • POST /v1/comments
  • DELETE /v1/comments/:commentId
  • PUT /v1/comments/:commentId

Session

  • POST /v1/session - sign in

Users

  • POST /v1/users - create a user
  • POST /v1/users/updateProfilePicture - upload profile picture
  • GET /v1/users/:username
  • GET /v1/users/whoami - returns current user
  • GET /v1/users/:username/subscribers - returns Posts timeline subscribers
  • GET /v1/users/:username/subscriptions - returns Posts timeline subscribers
  • PUT /v1/users/:userId - update user
  • POST /v1/users/:username/ban
  • POST /v1/users/:username/unban
  • PUT /v1/users/updatePassword - update user's password
  • PUT /v1/users/:username/subscribe - subscribe to user
  • PUT /v1/users/:username/unsubscribe - unsubscribe to user

Groups

  • POST /v1/groups - create group
  • POST /v1/groups/:group/subscribers/:username/admin - make admin
  • POST /v1/groups/:group/subscribers/:username/unadmin - remove admin privileges from
  • POST /v1/groups/:groupName/updateProfilePicture - upload group avatar

Passwords

  • POST /v1/passwords - request reset password
  • POST /v1/passwords/:resetPasswordToken - reset password

SEARCH API (master branch only)

  • GET /v1/search/:query - returns all posts which equals query.

Search query is a string of keywords. Keywords:

  • intitle:query (search query in post's body)
  • incomment:query (search query in comment's body)
  • from:username (search by username)
  • AND
  • OR
  • ' ' (whitespace)

If you enter a search phrase that does not match keywords above, search engine will search it in post's and comment's bodies.

Example: this AND intitle:that OR incomment:comment from:user. Search engine will return posts that contain 'that' in post's body and 'this' in post's or comment's body, also it will return posts that contain 'comment' in comment's body and written by user 'user'.