• Ruffnote v1

Resources

Attachments

Resource	Description
GET /api/v1/:team/:note/attachments	List note attachments
DELETE /api/v1/:team/:note/attachments/:id	Destroy
POST /api/v1/:team/:note/attachments	Create
GET /api/v1/attachments/:id	Get a single attachment

Credentials

Resource	Description
GET /api/v1/me	Get the authenticated user

Histories

Resource	Description
GET /api/v1/:team/:note/:page/histories	List page histories
GET /api/v1/:team/:note/:page/histories/:index	Get a single history
GET /api/v1/:team/:note/:page/histories/diff	Get diff

Issues

Resource	Description
GET /api/v1/:team/:note/issues	List note issues
GET /api/v1/:team/:note/issues/:index	Get a single issue
POST /api/v1/:team/:note/issues	Create
PATCH /api/v1/:team/:note/issues/:index	Update
DELETE /api/v1/:team/:note/issues/:index	Destroy
GET /api/v1/:team/:note/issues/:index/comments	List comments
POST /api/v1/:team/:note/issues/:index/comments	Create comment
DELETE /api/v1/:team/:note/issues/:index/comments/:id	Destroy comment
GET /api/v1/:team/:note/issues/:index/tags	List tags
POST /api/v1/:team/:note/issues/:index/tags	Add tag
DELETE /api/v1/:team/:note/issues/:index/tags/:name	Delete tag

Notes

Resource	Description
GET /api/v1/notes	List team notes
GET /api/v1/:team/:note	Get a single note
POST /api/v1/notes	Create
PATCH /api/v1/:team/:note	Update
DELETE /api/v1/:team/:note	Destroy
GET /api/v1/:team/:note/contributors	List contributors
POST /api/v1/:team/:note/forks	Fork
GET /api/v1/:team/:note/comments	List comments
POST /api/v1/:team/:note/comments	Create comment
DELETE /api/v1/:team/:note/comments/:id	Destroy comment
GET /api/v1/:team/:note/tags	List tags
GET /api/v1/:team/:note/hooks	List hooks
POST /api/v1/:team/:note/hooks	Create hook
DELETE /api/v1/:team/:note/hooks/:id	Destroy hook

Notifications

Resource	Description
GET /api/v1/notifications	List notifications
PATCH /api/v1/notifications/:id	Toggle

Pages

Resource	Description
GET /api/v1/:team/:note/pages	List note pages
GET /api/v1/:team/:note/:id	Get a single page
POST /api/v1/:team/:note/pages	Create
PATCH /api/v1/:team/:note/:id	Update
DELETE /api/v1/:team/:note/:id	Destroy
GET /api/v1/:team/:note/:id/comments	List comments
POST /api/v1/:team/:note/:id/comments	Create comment
DELETE /api/v1/:team/:note/:id/comments/:id	Destroy comment

Requests

Resource	Description
GET /api/v1/:team/:note/requests	List note requests
GET /api/v1/:team/:note/requests/:index	Get a single request
POST /api/v1/:team/:note/requests	Create
PATCH /api/v1/:team/:note/requests/:index/merge	Merge
PATCH /api/v1/:team/:note/requests/:index/close	Close
PATCH /api/v1/:team/:note/requests/:index/open	Open
DELETE /api/v1/:team/:note/requests/:index	Destroy
GET /api/v1/:team/:note/requests/:index/comments	List comments
POST /api/v1/:team/:note/requests/:index/comments	Create comment
DELETE /api/v1/:team/:note/requests/:index/comments/:id	Destroy comment

Teams

Resource	Description
GET /api/v1/teams	List user teams
GET /api/v1/teams/:name	Get a single team
GET /api/v1/teams/:name/notes	List team notes
POST /api/v1/teams	Create
PATCH /api/v1/teams/:name	Update
DELETE /api/v1/teams/:name	Destroy
POST /api/v1/teams/:team/users	Add user
DELETE /api/v1/teams/:team/users/:id	Delete user

Users

Resource	Description
GET /api/v1/users	Get all users
GET /api/v1/users/:username	Get a single user
GET /api/v1/users/:username/notes	List user notes

Welcome

Resource	Description
GET /api/v1/logs	Get user logs
GET /api/v1/my_issues	Get user issues
GET /api/v1/checks	Get user checks
GET /api/v1/search	Search user notes
GET /api/v1/usernames	List all usernames