Redbooth RESTful API - v2

Resources

Activities
Activities

Resource Description
GET /api/2/activities List activities

Attachments
Attachments

Resource Description
GET /api/2/attachments List attachments
GET /api/2/attachments/:id Attachment detail
GET /api/2attachments/:id/public_url Returns the attachment detail with a public_url attribute
DELETE /api/2/attachments/:id Deletes an attachment

Comments

Resource Description
GET /api/2/comments List comments
GET /api/2/comments/time_tracking List comments
GET /api/2/comments/:id Comment detail
POST /api/2/comments Create a new comment
PUT /api/2/comments/:id Updates a comment
DELETE /api/2/comments/:id Deletes a comment
GET /api/2/comments/:id/metadata Return all the metadata
GET /api/2/comments/:id/metadata/:key Return metadata for a specific key
PUT /api/2/comments/:id/metadata/:key Update metadata on a specific key
DELETE /api/2/comments/:id/metadata/:key Delete metadata on a specific key

Conversations
Conversations

Resource Description
GET /api/2/conversations List conversations
GET /api/2/conversations/:id Conversation detail
POST /api/2/conversations Create a new conversation
PUT /api/2/conversations/:id Updates a conversation
DELETE /api/2/conversations/:id Deletes a conversation
GET /api/2/conversations/:id/metadata Return all the metadata
GET /api/2/conversations/:id/metadata/:key Return metadata for a specific key
PUT /api/2/conversations/:id/metadata/:key Update metadata on a specific key
DELETE /api/2/conversations/:id/metadata/:key Delete metadata on a specific key

Events
Events

Resource Description
GET /api/2/events/:id Event detail
GET /api/2/events/:id/ical Event ics file
GET /api/2/events/:id/gcal Event ics file
POST /api/2/events Create a new event

Folders
Folders

Resource Description
GET /api/2/folders List folders
GET /api/2/folders/:id Folder detail
PUT /api/2/folders/:id Updates a folder
POST /api/2/folders Create a new folder
DELETE /api/2/folders/:id Deletes a folder
GET /api/2/folders/:id/metadata Return all the metadata
GET /api/2/folders/:id/metadata/:key Return metadata for a specific key
PUT /api/2/folders/:id/metadata/:key Update metadata on a specific key
DELETE /api/2/folders/:id/metadata/:key Delete metadata on a specific key

Hours
Time tracking

Resource Description
GET /api/2/comments/time_tracking List comments with tracked ours

Memberships
Memberships

Resource Description
GET /api/2/memberships List memberships
GET /api/2/memberships/:id Membership detail
POST /api/2/memberships Creates a new membership relation
PUT /api/2/memberships/:id Updates a membership relation
DELETE /api/2/memberships/:id Deletes a membership

Organizations
Orgnaizations

Resource Description
GET /api/2/organizations List organizations
GET /api/2/organizations/:id Organization detail
POST /api/2/organizations Create a new organization
PUT /api/2/organizations/:id Updates an organization
POST /api/2/organizations/:id/delete/enqueue Deletes a organization asynchronously
GET /api/2/organizations/:id/metadata Return all the metadata
GET /api/2/organizations/:id/metadata/:key Return metadata for a specific key
PUT /api/2/organizations/:id/metadata/:key Update metadata on a specific key
DELETE /api/2/organizations/:id/metadata/:key Delete metadata on a specific key

Pages
Pages

Resource Description
GET /api/2/pages List pages
GET /api/2/pages/:id Page detail
POST /api/2/pages Creates a new page
PUT /api/2/pages/:id Updates a page
GET /api/2/pages/:id/history Page History
DELETE /api/2/pages/:id Delete page
PUT /api/2/pages/reorder Reorder pages
GET /api/2/pages/:id/metadata Return all the metadata
GET /api/2/pages/:id/metadata/:key Return metadata for a specific key
PUT /api/2/pages/:id/metadata/:key Update metadata on a specific key
DELETE /api/2/pages/:id/metadata/:key Delete metadata on a specific key

People
Project members

Resource Description
GET /api/2/people List project people
GET /api/2/people/:id Person detail
POST /api/2/people Create a new person relation
PUT /api/2/people/:id Updates a person relation
DELETE /api/2/people/:id Deletes a person

Projects
Projects

Resource Description
GET /api/2/projects Lists projects
GET /api/2/projects/:id Project detail
POST /api/2/projects Create a new project
PUT /api/2/projects/:id Updates a project
DELETE /api/2/projects/:id Deletes a project
GET /api/2/projects/:id/metadata Return all the metadata
GET /api/2/projects/:id/metadata/:key Return metadata for a specific key
PUT /api/2/projects/:id/metadata/:key Update metadata on a specific key
DELETE /api/2/projects/:id/metadata/:key Delete metadata on a specific key
GET /api/2/projects/:id/settings Return all the settings
GET /api/2/projects/:id/settings/:key Return settings for a specific key
PUT /api/2/projects/:id/settings/:key Update settings on a specific key
DELETE /api/2/projects/:id/settings/:key Delete settings on a specific key

Task list templates

Resource Description
GET /api/2/task_list_templates List task lists templates
GET /api/2/task_list_templates/:id Task List Template detail
POST /api/2/task_list_template Create a new task list template
PUT /api/2/task_list_template/:id Updates a task list template
DELETE /api/2/task_list_template/:id Deletes a task list template

Task lists
Task lists

Resource Description
GET /api/2/task_lists List task lists
GET /api/2/task_list/:id Task list detail
POST /api/2/task_list_id Create a new task list
PUT /api/2/task_list/:id Updates a task
PUT /api/2/task_lists Reorder task lists
PUT /api/2/task_lists/:id/archive Archives the given task list
PUT /api/2/task_lists/:id/unarchive Unarchives the given task list
DELETE /api/2/task_list/:id Deletes a task
GET /api/2/tasklists/:id/metadata Return all the metadata
GET /api/2/tasklists/:id/metadata/:key Return metadata for a specific key
PUT /api/2/tasklists/:id/metadata/:key Update metadata on a specific key
DELETE /api/2/tasklists/:id/metadata/:key Delete metadata on a specific key

Tasks
Tasks

Resource Description
GET /api/2/tasks List tasks
GET /api/2/tasks/:id Task detail
POST /api/2/tasks Create a new task
PUT /api/2/tasks/:id Updates a task
DELETE /api/2/tasks/:id Deletes a task
PUT /api/2/tasks/:id/watch Adds the current user as a task watcher
PUT /api/2/tasks/:id/unwatch Removes the current user as a task watcher
PUT /api/2/tasks Reorder tasks
GET /api/2/tasks/:id/metadata Return all the metadata
GET /api/2/tasks/:id/metadata/:key Return metadata for a specific key
PUT /api/2/tasks/:id/metadata/:key Update metadata on a specific key
DELETE /api/2/tasks/:id/metadata/:key Delete metadata on a specific key

Threads
Threads

Resource Description
GET /api/2/threads List activities without comment activities

Uploads
Uploads

Resource Description
GET /api/2/uploads List uploads
GET /api/2/uploads/:id Task detail
PUT /api/2/uploads/:id Updates a upload
POST /api/2/uploads Create a new upload
DELETE /api/2/uploads/:id Deletes an upload
POST /api/2/uploads/:id/share Shares an upload
GET /api/2/uploads/:id/metadata Return all the metadata
GET /api/2/uploads/:id/metadata/:key Return metadata for a specific key
PUT /api/2/uploads/:id/metadata/:key Update metadata on a specific key
DELETE /api/2/uploads/:id/metadata/:key Delete metadata on a specific key

Users
Site members

Resource Description
GET /api/2/users List users
GET /api/2/users/:id Show user profile
POST /api/2/users Create a new user
PUT /api/2/users/:id Update a user
POST /api/2/users/:id/regenerate_rss_token Deletes a user
POST /api/2/users/:id/delete/enqueue Deletes a user
GET /api/2/users/:id/metadata Return all the metadata
GET /api/2/users/:id/metadata/:key Return metadata for a specific key
PUT /api/2/users/:id/metadata/:key Update metadata on a specific key
DELETE /api/2/users/:id/metadata/:key Delete metadata on a specific key
GET /api/2/users/:id/settings Return all the settings
GET /api/2/users/:id/settings/:key Return settings for a specific key
PUT /api/2/users/:id/settings/:key Update settings on a specific key
DELETE /api/2/users/:id/settings/:key Delete settings on a specific key