API Documentation

Authentication

All requests below require authentication, using your unique token:

Login in order to see your token here

Ruby Gem

A good way to start for rubyists is with the Everytime gem: https://github.com/everytimehq/everytime

Rate limits

There are currently no limits to the number of requests you can send, but some reasonable limits might be applied in the future.

Endpoint and format

All api requests should be called to https://www.everytimehq.com/api/v1 using json or jsonp. Note that jsonp applies only for GET requests.

Create a project

curl -d 'name=visual+references&public=false' https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/projects
{"id":1214,"name":"visual references","created_at":"2014-05-13T21:54:46.015+01:00","public":false,"human_url":"https://www.everytimehq.com/projects/1214-visual-references","api_url":"https://www.everytimehq.com/api/v1/projects/1214-visual-references","media":[],"users":[{"id":1010,"full_name":"api_doc","created_at":"2014-04-21T00:21:14.902+01:00","human_url":"https://www.everytimehq.com/users/1010-api-doc"}],"todo_lists":[],"play_lists":[],"storyboards":[]}

List your projects

curl https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/projects
[{"id":1214,"name":"visual references","created_at":"2014-05-13T21:54:46.015+01:00","public":false,"human_url":"https://www.everytimehq.com/projects/1214-visual-references","api_url":"https://www.everytimehq.com/api/v1/projects/1214-visual-references"}]

Show a project

curl https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/projects/1214
{"id":1214,"name":"visual references","created_at":"2014-05-13T21:54:46.015+01:00","public":false,"human_url":"https://www.everytimehq.com/projects/1214-visual-references","api_url":"https://www.everytimehq.com/api/v1/projects/1214-visual-references","media":[],"users":[{"id":1010,"full_name":"api_doc","created_at":"2014-04-21T00:21:14.902+01:00","human_url":"https://www.everytimehq.com/users/1010-api-doc"}],"todo_lists":[],"play_lists":[],"storyboards":[]}

Update a project

curl -X PATCH -d 'id=1214&name=new+name' https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/projects/1214

Delete a project

curl -X DELETE https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/projects/1214

Import a video or music

curl -d 'path=https%3A%2F%2Fvimeo.com%2F13247598' https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/projects/:project_id/media
{"id":10409,"human_name":"video","title":"Puppet","service_origin_url":"https://vimeo.com/13247598","path":"https://vimeo.com/13247598","project_id":1214,"user_id":1010,"created_at":"2014-05-13T21:54:48.608+01:00","human_url":"https://www.everytimehq.com/media/10409-Puppet","api_url":"https://www.everytimehq.com/api/v1/media/10409-Puppet","project":{"id":1214,"name":"new name","created_at":"2014-05-13T21:54:46.015+01:00","public":false,"human_url":"https://www.everytimehq.com/projects/1214-new-name","api_url":"https://www.everytimehq.com/api/v1/projects/1214-new-name"},"user":{"id":1010,"full_name":"api_doc","created_at":"2014-04-21T00:21:14.902+01:00","human_url":"https://www.everytimehq.com/users/1010-api-doc"},"bookmarks":[]}

List all media inside a project

curl https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/projects/:project_id/media
[{"id":10409,"human_name":"video","title":"Puppet","service_origin_url":"https://vimeo.com/13247598","path":"https://vimeo.com/13247598","project_id":1214,"user_id":1010,"created_at":"2014-05-13T21:54:48.608+01:00","human_url":"https://www.everytimehq.com/media/10409-Puppet","api_url":"https://www.everytimehq.com/api/v1/media/10409-Puppet"}]

Show a medium

curl https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/media/10409
{"id":10409,"human_name":"video","title":"Puppet","service_origin_url":"https://vimeo.com/13247598","path":"https://vimeo.com/13247598","project_id":1214,"user_id":1010,"created_at":"2014-05-13T21:54:48.608+01:00","human_url":"https://www.everytimehq.com/media/10409-Puppet","api_url":"https://www.everytimehq.com/api/v1/media/10409-Puppet","project":{"id":1214,"name":"new name","created_at":"2014-05-13T21:54:46.015+01:00","public":false,"human_url":"https://www.everytimehq.com/projects/1214-new-name","api_url":"https://www.everytimehq.com/api/v1/projects/1214-new-name"},"user":{"id":1010,"full_name":"api_doc","created_at":"2014-04-21T00:21:14.902+01:00","human_url":"https://www.everytimehq.com/users/1010-api-doc"},"bookmarks":[]}

Update a medium

curl -X PATCH -d 'id=10409&title=Scary+short+film' https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/media/10409

Delete a medium

curl -X DELETE https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/media/10409
{}

Add a bookmark

curl -d 'start_time=10000&title=best+moment' https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/media/:medium_id/bookmarks
{"id":4396,"title":"best moment","medium_id":10409,"user_id":1010,"start_time":10000,"end_time":120100,"timecode":"00:10","created_at":"2014-05-13T21:54:51.190+01:00","human_url":"https://www.everytimehq.com/bookmarks/4396-best-moment","api_url":"https://www.everytimehq.com/api/v1/bookmarks/4396-best-moment","play_lists":[],"project":{"id":1214,"name":"new name","created_at":"2014-05-13T21:54:46.015+01:00","public":false,"human_url":"https://www.everytimehq.com/projects/1214-new-name","api_url":"https://www.everytimehq.com/api/v1/projects/1214-new-name"},"comments":[]}

List all bookmarks in a medium

curl https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/media/:medium_id/bookmarks
[{"id":4396,"title":"best moment","medium_id":10409,"user_id":1010,"start_time":10000,"end_time":120100,"timecode":"00:10","created_at":"2014-05-13T21:54:51.190+01:00","human_url":"https://www.everytimehq.com/bookmarks/4396-best-moment","api_url":"https://www.everytimehq.com/api/v1/bookmarks/4396-best-moment"}]

Show a bookmark

curl https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/bookmarks/4396
{"id":4396,"title":"best moment","medium_id":10409,"user_id":1010,"start_time":10000,"end_time":120100,"timecode":"00:10","created_at":"2014-05-13T21:54:51.190+01:00","human_url":"https://www.everytimehq.com/bookmarks/4396-best-moment","api_url":"https://www.everytimehq.com/api/v1/bookmarks/4396-best-moment","play_lists":[],"project":{"id":1214,"name":"new name","created_at":"2014-05-13T21:54:46.015+01:00","public":false,"human_url":"https://www.everytimehq.com/projects/1214-new-name","api_url":"https://www.everytimehq.com/api/v1/projects/1214-new-name"},"comments":[]}

Update a bookmark

curl -X PATCH -d 'id=4396&title=the+scariest+moment' https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/bookmarks/4396

Delete a bookmark

curl -X DELETE https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/bookmarks/4396
{}

Create a storyboard

curl -d 'name=intro+sequence' https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/projects/:project_id/storyboards
{"id":149,"name":"intro sequence","project_id":1214,"user_id":1010,"created_at":"2014-05-13T21:54:53.833+01:00","human_url":"https://www.everytimehq.com/storyboards/149-intro-sequence","api_url":"https://www.everytimehq.com/api/v1/storyboards/149-intro-sequence","project":{"id":1214,"name":"new name","created_at":"2014-05-13T21:54:46.015+01:00","public":false,"human_url":"https://www.everytimehq.com/projects/1214-new-name","api_url":"https://www.everytimehq.com/api/v1/projects/1214-new-name"},"user":{"id":1010,"full_name":"api_doc","created_at":"2014-04-21T00:21:14.902+01:00","human_url":"https://www.everytimehq.com/users/1010-api-doc"},"items":[],"comments":[]}

List all storyboards inside a project

curl https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/projects/:project_id/storyboards
[{"id":149,"name":"intro sequence","project_id":1214,"user_id":1010,"created_at":"2014-05-13T21:54:53.833+01:00","human_url":"https://www.everytimehq.com/storyboards/149-intro-sequence","api_url":"https://www.everytimehq.com/api/v1/storyboards/149-intro-sequence"}]

Show a storyboard

curl https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/storyboards/149
{"id":149,"name":"intro sequence","project_id":1214,"user_id":1010,"created_at":"2014-05-13T21:54:53.833+01:00","human_url":"https://www.everytimehq.com/storyboards/149-intro-sequence","api_url":"https://www.everytimehq.com/api/v1/storyboards/149-intro-sequence","project":{"id":1214,"name":"new name","created_at":"2014-05-13T21:54:46.015+01:00","public":false,"human_url":"https://www.everytimehq.com/projects/1214-new-name","api_url":"https://www.everytimehq.com/api/v1/projects/1214-new-name"},"user":{"id":1010,"full_name":"api_doc","created_at":"2014-04-21T00:21:14.902+01:00","human_url":"https://www.everytimehq.com/users/1010-api-doc"},"items":[],"comments":[]}

Update a storyboard

curl -X PATCH -d 'id=149&name=end+sequence' https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/storyboards/149

Delete a storyboard

curl -X DELETE https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/storyboards/149
{}

Add a drawing to a storyboard

curl -d 'description=first+shot' https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/storyboards/:storyboard_id/drawings
{"id":339,"name":"drawing ","parent_id":149,"user_id":1010,"created_at":"2014-05-13T21:54:56.509+01:00","description":"first shot","human_url":"https://www.everytimehq.com/drawings/339","api_url":"https://www.everytimehq.com/api/v1/drawings/339","project":{"id":1214,"name":"new name","created_at":"2014-05-13T21:54:46.015+01:00","public":false,"human_url":"https://www.everytimehq.com/projects/1214-new-name","api_url":"https://www.everytimehq.com/api/v1/projects/1214-new-name"},"user":{"id":1010,"full_name":"api_doc","created_at":"2014-04-21T00:21:14.902+01:00","human_url":"https://www.everytimehq.com/users/1010-api-doc"},"comments":[]}

List all drawings in a storyboard

curl https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/storyboards/:storyboard_id/drawings
[{"id":339,"name":"drawing 0","parent_id":149,"user_id":1010,"created_at":"2014-05-13T21:54:56.509+01:00","description":"first shot","human_url":"https://www.everytimehq.com/drawings/339","api_url":"https://www.everytimehq.com/api/v1/drawings/339"}]

Show a drawing

curl https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/drawings/339
{"id":339,"name":"drawing 0","parent_id":149,"user_id":1010,"created_at":"2014-05-13T21:54:56.509+01:00","description":"first shot","human_url":"https://www.everytimehq.com/drawings/339","api_url":"https://www.everytimehq.com/api/v1/drawings/339","project":{"id":1214,"name":"new name","created_at":"2014-05-13T21:54:46.015+01:00","public":false,"human_url":"https://www.everytimehq.com/projects/1214-new-name","api_url":"https://www.everytimehq.com/api/v1/projects/1214-new-name"},"user":{"id":1010,"full_name":"api_doc","created_at":"2014-04-21T00:21:14.902+01:00","human_url":"https://www.everytimehq.com/users/1010-api-doc"},"comments":[]}

Update a drawing

curl -X PATCH -d 'description=the+best+shot+of+the+movie&id=339' https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/drawings/339

Delete a drawing

curl -X DELETE https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/drawings/339
{}

Create a todo list

curl -d 'name=potential+actors' https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/projects/:project_id/todo_lists
{"id":729,"name":"potential actors","project_id":1214,"user_id":1010,"created_at":"2014-05-13T21:54:59.182+01:00","project":{"id":1214,"name":"new name","created_at":"2014-05-13T21:54:46.015+01:00","public":false,"human_url":"https://www.everytimehq.com/projects/1214-new-name","api_url":"https://www.everytimehq.com/api/v1/projects/1214-new-name"},"user":{"id":1010,"full_name":"api_doc","created_at":"2014-04-21T00:21:14.902+01:00","human_url":"https://www.everytimehq.com/users/1010-api-doc"},"items":[],"comments":[]}

List all todo lists inside a project

curl https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/projects/:project_id/todo_lists
[{"id":729,"name":"potential actors","project_id":1214,"user_id":1010,"created_at":"2014-05-13T21:54:59.182+01:00"}]

Show a todo list

curl https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/todo_lists/729
{"id":729,"name":"potential actors","project_id":1214,"user_id":1010,"created_at":"2014-05-13T21:54:59.182+01:00","project":{"id":1214,"name":"new name","created_at":"2014-05-13T21:54:46.015+01:00","public":false,"human_url":"https://www.everytimehq.com/projects/1214-new-name","api_url":"https://www.everytimehq.com/api/v1/projects/1214-new-name"},"user":{"id":1010,"full_name":"api_doc","created_at":"2014-04-21T00:21:14.902+01:00","human_url":"https://www.everytimehq.com/users/1010-api-doc"},"items":[],"comments":[]}

Update a todo list

curl -X PATCH -d 'id=729&name=potential+actors+and+producers' https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/todo_lists/729

Delete a todo list

curl -X DELETE https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/todo_lists/729
{}

Add a todo item to a todo list

curl -d 'text=Sarah+Connor' https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/todo_lists/:todo_list_id/todo_items
{"id":4931,"text":"Sarah Connor","user_id":1010,"completed":false,"created_at":"2014-05-13T21:55:02.638+01:00","project":{"id":1214,"name":"new name","created_at":"2014-05-13T21:54:46.015+01:00","public":false,"human_url":"https://www.everytimehq.com/projects/1214-new-name","api_url":"https://www.everytimehq.com/api/v1/projects/1214-new-name"},"user":{"id":1010,"full_name":"api_doc","created_at":"2014-04-21T00:21:14.902+01:00","human_url":"https://www.everytimehq.com/users/1010-api-doc"},"comments":[]}

List all todo items in a todo list

curl https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/todo_lists/:todo_list_id/todo_items
[{"id":4931,"text":"Sarah Connor","user_id":1010,"completed":false,"created_at":"2014-05-13T21:55:02.638+01:00"}]

Show a todo item

curl https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/todo_items/4931
{"id":4931,"text":"Sarah Connor","user_id":1010,"completed":false,"created_at":"2014-05-13T21:55:02.638+01:00","project":{"id":1214,"name":"new name","created_at":"2014-05-13T21:54:46.015+01:00","public":false,"human_url":"https://www.everytimehq.com/projects/1214-new-name","api_url":"https://www.everytimehq.com/api/v1/projects/1214-new-name"},"user":{"id":1010,"full_name":"api_doc","created_at":"2014-04-21T00:21:14.902+01:00","human_url":"https://www.everytimehq.com/users/1010-api-doc"},"comments":[]}

Update a todo item

curl -X PATCH -d 'id=4931&name=Arnie' https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/todo_items/4931

Delete a todo item

curl -X DELETE https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/todo_items/4931
{}

Create a playlist

curl -d 'name=Location+scouting' https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/projects/:project_id/play_lists
{"id":618,"name":"Location scouting","project_id":1214,"user_id":1010,"created_at":"2014-05-13T21:55:05.140+01:00","project":{"id":1214,"name":"new name","created_at":"2014-05-13T21:54:46.015+01:00","public":false,"human_url":"https://www.everytimehq.com/projects/1214-new-name","api_url":"https://www.everytimehq.com/api/v1/projects/1214-new-name"},"user":{"id":1010,"full_name":"api_doc","created_at":"2014-04-21T00:21:14.902+01:00","human_url":"https://www.everytimehq.com/users/1010-api-doc"},"media":[],"bookmarks":[]}

List all playlists in a project

curl https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/projects/:project_id/play_lists
[{"id":618,"name":"Location scouting","project_id":1214,"user_id":1010,"created_at":"2014-05-13T21:55:05.140+01:00"}]

Show a playlist

curl https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/play_lists/618
{"id":618,"name":"Location scouting","project_id":1214,"user_id":1010,"created_at":"2014-05-13T21:55:05.140+01:00","project":{"id":1214,"name":"new name","created_at":"2014-05-13T21:54:46.015+01:00","public":false,"human_url":"https://www.everytimehq.com/projects/1214-new-name","api_url":"https://www.everytimehq.com/api/v1/projects/1214-new-name"},"user":{"id":1010,"full_name":"api_doc","created_at":"2014-04-21T00:21:14.902+01:00","human_url":"https://www.everytimehq.com/users/1010-api-doc"},"media":[],"bookmarks":[]}

Update a playlist

curl -X PATCH -d 'id=618&name=scary+locations' https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/play_lists/618

Delete a playlist

curl -X DELETE https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/play_lists/618
{}

Add a comment to a video or music

curl -d 'content=comment+content' https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/media/:medium_id/comments
{"id":1334,"parent_id":10409,"parent_type":"Medium","parent_human_name":"video","user_id":1010,"content":"comment content","created_at":"2014-05-13T21:55:07.721+01:00","parent":{"id":10409,"human_name":"video","title":"Scary short film","service_origin_url":"https://vimeo.com/13247598","path":"https://vimeo.com/13247598","project_id":1214,"user_id":1010,"created_at":"2014-05-13T21:54:48.608+01:00","human_url":"https://www.everytimehq.com/media/10409-Scary-short-film","api_url":"https://www.everytimehq.com/api/v1/media/10409-Scary-short-film"}}

Add a comment to a bookmark

curl -d 'content=comment+content' https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/bookmarks/:bookmark_id/comments
{"id":1335,"parent_id":4396,"parent_type":"Bookmark","parent_human_name":"bookmark","user_id":1010,"content":"comment content","created_at":"2014-05-13T21:55:08.973+01:00","parent":{"id":4396,"title":"the scariest moment","medium_id":10409,"user_id":1010,"start_time":10000,"end_time":120100,"timecode":"00:10","created_at":"2014-05-13T21:54:51.190+01:00","human_url":"https://www.everytimehq.com/bookmarks/4396-the-scariest-moment","api_url":"https://www.everytimehq.com/api/v1/bookmarks/4396-the-scariest-moment"}}

Add a comment to a storyboard

curl -d 'content=comment+content' https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/storyboards/:storyboard_id/comments
{"id":1336,"parent_id":149,"parent_type":"Storyboard","parent_human_name":"storyboard","user_id":1010,"content":"comment content","created_at":"2014-05-13T21:55:10.392+01:00","parent":{"id":149,"name":"end sequence","project_id":1214,"user_id":1010,"created_at":"2014-05-13T21:54:53.833+01:00","human_url":"https://www.everytimehq.com/storyboards/149-end-sequence","api_url":"https://www.everytimehq.com/api/v1/storyboards/149-end-sequence"}}

Add a comment to a drawing

curl -d 'content=comment+content' https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/drawings/:drawing_id/comments
{"id":1337,"parent_id":339,"parent_type":"Drawing","parent_human_name":"drawing","user_id":1010,"content":"comment content","created_at":"2014-05-13T21:55:11.626+01:00","parent":{"id":339,"name":"drawing 0","parent_id":149,"user_id":1010,"created_at":"2014-05-13T21:54:56.509+01:00","description":"the best shot of the movie","human_url":"https://www.everytimehq.com/drawings/339","api_url":"https://www.everytimehq.com/api/v1/drawings/339"}}

Add a comment to a todo list

curl -d 'content=comment+content' https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/todo_lists/:todo_list_id/comments
{"id":1338,"parent_id":729,"parent_type":"TodoList","parent_human_name":"todo list","user_id":1010,"content":"comment content","created_at":"2014-05-13T21:55:12.807+01:00","parent":{"id":729,"name":"potential actors and producers","project_id":1214,"user_id":1010,"created_at":"2014-05-13T21:54:59.182+01:00"}}

Add a comment to a todo item

curl -d 'content=comment+content' https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/todo_items/:todo_item_id/comments
{"id":1339,"parent_id":4931,"parent_type":"TodoItem","parent_human_name":"todo","user_id":1010,"content":"comment content","created_at":"2014-05-13T21:55:14.010+01:00","parent":{"id":4931,"text":"Sarah Connor","user_id":1010,"completed":false,"created_at":"2014-05-13T21:55:02.638+01:00"}}

Add a comment to a playlist

curl -d 'content=comment+content' https://<YOUR SECRET TOKEN>@www.everytimehq.com/api/v1/play_lists/:play_list_id/comments
{"id":1340,"parent_id":618,"parent_type":"PlayList","parent_human_name":"playlist","user_id":1010,"content":"comment content","created_at":"2014-05-13T21:55:15.002+01:00","parent":{"id":618,"name":"scary locations","project_id":1214,"user_id":1010,"created_at":"2014-05-13T21:55:05.140+01:00"}}