Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/comments
curl \
--request GET 'http://api.example.com/data/comments' \
--header "Authorization: $API_KEY"
Log in user by creating and registering auth tokens.
Login is based on email and password. If no user match given email and a destkop ID, it looks in matching the desktop ID with the one stored in database. It is useful for clients that run on desktop tools and that don't know user email.
POST
/auth/login
curl \
--request POST 'http://api.example.com/auth/login' \
--header "Authorization: $API_KEY"Log user out by revoking his auth tokens.
Once logged out, current user cannot access the API anymore.
GET
/auth/logout
curl \
--request GET 'http://api.example.com/auth/logout' \
--header "Authorization: $API_KEY"Resource to allow a user to change his password when he forgets it.
It uses a classic scheme: a token is sent by email to the user. Then he can change his password.
PUT
/auth/reset-password
curl \
--request PUT 'http://api.example.com/auth/reset-password' \
--header "Authorization: $API_KEY"
PUT
/auth/email-otp
curl \
--request PUT 'http://api.example.com/auth/email-otp' \
--header "Authorization: $API_KEY"
PUT
/auth/recovery-codes
curl \
--request PUT 'http://api.example.com/auth/recovery-codes' \
--header "Authorization: $API_KEY"Path parameters
-
asset_type_id
Required
GET
/data/asset-types/{asset_type_id}
curl \
--request GET 'http://api.example.com/data/asset-types/{asset_type_id}' \
--header "Authorization: $API_KEY"Path parameters
-
asset_id
Required
DELETE
/data/assets/{asset_id}
curl \
--request DELETE 'http://api.example.com/data/assets/{asset_id}' \
--header "Authorization: $API_KEY"Retrieve all scene asset instances linked to given asset.
Path parameters
-
asset_id
Required
GET
/data/assets/{asset_id}/scene-asset-instances
curl \
--request GET 'http://api.example.com/data/assets/{asset_id}/scene-asset-instances' \
--header "Authorization: $API_KEY"Create an asset instance inside given asset.
Path parameters
-
asset_id
Required
POST
/data/assets/{asset_id}/asset-asset-instances
curl \
--request POST 'http://api.example.com/data/assets/{asset_id}/asset-asset-instances' \
--header "Authorization: $API_KEY"Retrieve all asset types for given project.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/asset-types
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/asset-types' \
--header "Authorization: $API_KEY"Resource to retrieve the casting of assets from given asset type.
Path parameters
-
project_id
Required -
asset_type_id
Required
GET
/data/projects/{project_id}/asset-types/{asset_type_id}/casting
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/asset-types/{asset_type_id}/casting' \
--header "Authorization: $API_KEY"Resource to retrieve the casting of shots from all sequences of given
project.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/sequences/all/casting
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/sequences/all/casting' \
--header "Authorization: $API_KEY"Delete given entity link.
It's mainly used for synchronisation purpose.
Path parameters
-
project_id
Required -
entity_link_id
Required
DELETE
/data/projects/{project_id}/entity-links/{entity_link_id}
curl \
--request DELETE 'http://api.example.com/data/projects/{project_id}/entity-links/{entity_link_id}' \
--header "Authorization: $API_KEY"Acknowledge given comment.
If it's already acknowledged, remove acknowledgement.
Path parameters
-
task_id
Required -
comment_id
Required
POST
/data/tasks/{task_id}/comments/{comment_id}/ack
curl \
--request POST 'http://api.example.com/data/tasks/{task_id}/comments/{comment_id}/ack' \
--header "Authorization: $API_KEY"Create several comments at once.
Each comment requires a text, a task id, a task_status and a person as arguments. This way, comments keep history of status changes. When the comment is created, it updates the task status with given task status.
Path parameters
-
project_id
Required
POST
/actions/projects/{project_id}/tasks/comment-many
curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/tasks/comment-many' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/projects
curl \
--request GET 'http://api.example.com/data/projects' \
--header "Authorization: $API_KEY"Update a model with data given in the request body.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id
Required
PUT
/data/projects/{instance_id}
curl \
--request PUT 'http://api.example.com/data/projects/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/entity-types
curl \
--request GET 'http://api.example.com/data/entity-types' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/task-types
curl \
--request GET 'http://api.example.com/data/task-types' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/task-status
curl \
--request GET 'http://api.example.com/data/task-status' \
--header "Authorization: $API_KEY"Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
POST
/data/organisations
curl \
--request POST 'http://api.example.com/data/organisations' \
--header "Authorization: $API_KEY"Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
GET
/data/organisations/{instance_id}
curl \
--request GET 'http://api.example.com/data/organisations/{instance_id}' \
--header "Authorization: $API_KEY"Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
DELETE
/data/organisations/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/organisations/{instance_id}' \
--header "Authorization: $API_KEY"Update a model with data given in the request body.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id
Required
PUT
/data/file-status/{instance_id}
curl \
--request PUT 'http://api.example.com/data/file-status/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve a software corresponding at given ID and return it as a
JSON object.
Path parameters
-
software_id
Required
GET
/data/softwares/{instance_id}
curl \
--request GET 'http://api.example.com/data/softwares/{instance_id}' \
--header "Authorization: $API_KEY"Update a model with data given in the request body.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id
Required
PUT
/data/softwares/{instance_id}
curl \
--request PUT 'http://api.example.com/data/softwares/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
GET
/data/preview-files/{instance_id}
curl \
--request GET 'http://api.example.com/data/preview-files/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve a working file corresponding at given ID and return it as a
JSON object.
Path parameters
-
working_file_id
Required
GET
/data/working-files/{instance_id}
curl \
--request GET 'http://api.example.com/data/working-files/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/attachment-files
curl \
--request GET 'http://api.example.com/data/attachment-files' \
--header "Authorization: $API_KEY"Update a model with data given in the request body.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id
Required
PUT
/data/day-offs/{instance_id}
curl \
--request PUT 'http://api.example.com/data/day-offs/{instance_id}' \
--header "Authorization: $API_KEY"Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
DELETE
/data/day-offs/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/day-offs/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/asset-instances/
curl \
--request GET 'http://api.example.com/data/asset-instances/' \
--header "Authorization: $API_KEY"Update a model with data given in the request body.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id
Required
PUT
/data/asset-instances/{instance_id}
curl \
--request PUT 'http://api.example.com/data/asset-instances/{instance_id}' \
--header "Authorization: $API_KEY"Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
POST
/data/playlists/
curl \
--request POST 'http://api.example.com/data/playlists/' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/events/
curl \
--request GET 'http://api.example.com/data/events/' \
--header "Authorization: $API_KEY"Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
POST
/data/notifications/
curl \
--request POST 'http://api.example.com/data/notifications/' \
--header "Authorization: $API_KEY"Update a model with data given in the request body.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id
Required
PUT
/data/search-filters/{instance_id}
curl \
--request PUT 'http://api.example.com/data/search-filters/{instance_id}' \
--header "Authorization: $API_KEY"Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
DELETE
/data/search-filters/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/search-filters/{instance_id}' \
--header "Authorization: $API_KEY"Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
POST
/data/search-filter-groups/
curl \
--request POST 'http://api.example.com/data/search-filter-groups/' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/entity-links/
curl \
--request GET 'http://api.example.com/data/entity-links/' \
--header "Authorization: $API_KEY"Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
GET
/data/entity-links/{instance_id}
curl \
--request GET 'http://api.example.com/data/entity-links/{instance_id}' \
--header "Authorization: $API_KEY"Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
DELETE
/data/entity-links/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/entity-links/{instance_id}' \
--header "Authorization: $API_KEY"Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
POST
/data/salary-scales
curl \
--request POST 'http://api.example.com/data/salary-scales' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/plugins
curl \
--request GET 'http://api.example.com/data/plugins' \
--header "Authorization: $API_KEY"Path parameters
-
edit_id
Required
GET
/data/edits/{edit_id}/tasks
curl \
--request GET 'http://api.example.com/data/edits/{edit_id}/tasks' \
--header "Authorization: $API_KEY"Retrieve all time spents linked to a given entity.
Path parameters
-
entity_id
Required
GET
/data/entities/{entity_id}/time-spents
curl \
--request GET 'http://api.example.com/data/entities/{entity_id}/time-spents' \
--header "Authorization: $API_KEY"Export shots linked to a given project as csv.
Path parameters
-
project_id
Required
GET
/export/csv/projects/{project_id}/shots.csv
curl \
--request GET 'http://api.example.com/export/csv/projects/{project_id}/shots.csv' \
--header "Authorization: $API_KEY"Generate a working file path from file tree template.
Generate file path based on several parameters: task, software, mode, revision and separator. Revision can be computed automatically as next revision if not given.
Path parameters
-
task_id
Required
POST
/data/tasks/{task_id}/working-file-path
curl \
--request POST 'http://api.example.com/data/tasks/{task_id}/working-file-path' \
--header "Authorization: $API_KEY"Define a template file to use for given project.
Template files are located on the server side. Each template has a name which means that you just have to give a name to "select" the template to link with the project.
Path parameters
-
project_id
Required
POST
/actions/projects/{project_id}/set-file-tree
curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/set-file-tree' \
--header "Authorization: $API_KEY"Update comment on given working file.
Path parameters
-
working_file_id
Required
PUT
/actions/working-files/{working_file_id}/comment
curl \
--request PUT 'http://api.example.com/actions/working-files/{working_file_id}/comment' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/versions
curl \
--request POST 'http://api.example.com/import/shotgun/versions' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/notes
curl \
--request POST 'http://api.example.com/import/shotgun/notes' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/projectconnections
curl \
--request POST 'http://api.example.com/import/shotgun/projectconnections' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/remove/person
curl \
--request POST 'http://api.example.com/import/shotgun/remove/person' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/remove/episode
curl \
--request POST 'http://api.example.com/import/shotgun/remove/episode' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/remove/sequence
curl \
--request POST 'http://api.example.com/import/shotgun/remove/sequence' \
--header "Authorization: $API_KEY"Import project assets via a .csv file.
Path parameters
-
project_id
Required
POST
/import/csv/projects/{project_id}/assets
curl \
--request POST 'http://api.example.com/import/csv/projects/{project_id}/assets' \
--header "Authorization: $API_KEY"Import project shots via a .csv file.
Path parameters
-
project_id
Required
POST
/import/csv/projects/{project_id}/shots
curl \
--request POST 'http://api.example.com/import/csv/projects/{project_id}/shots' \
--header "Authorization: $API_KEY"
POST
/import/kitsu/entity-links
curl \
--request POST 'http://api.example.com/import/kitsu/entity-links' \
--header "Authorization: $API_KEY"Retrieve desktop login logs.
Desktop login logs can only be created by current user.
Path parameters
-
person_id
Required
GET
/data/persons/{person_id}/desktop-login-logs
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/desktop-login-logs' \
--header "Authorization: $API_KEY"Get day off object for given person and date.
GET
/data/persons/{person_id}/day-offs/{date}
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/day-offs/{date}' \
--header "Authorization: $API_KEY"Get aggregated time spents for given person and day.
GET
/data/persons/{person_id}/time-spents/day/{year}/{month}/{day}
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/time-spents/day/{year}/{month}/{day}' \
--header "Authorization: $API_KEY"Retrieve all playlists related to given project.
Path parameters
-
project_id
Required -
playlist_id
Required
GET
/data/projects/{project_id}/playlists/{playlist_id}
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/playlists/{playlist_id}' \
--header "Authorization: $API_KEY"Retrieve build job related to given playlist.
Path parameters
-
playlist_id
Required -
build_job_id
Required
GET
/data/playlists/{playlist_id}/jobs/{build_job_id}
curl \
--request GET 'http://api.example.com/data/playlists/{playlist_id}/jobs/{build_job_id}' \
--header "Authorization: $API_KEY"Retrieve all playlists related to given project.
It's mainly used for synchronisation purpose.
Path parameters
-
project_id
Required
POST
/data/projects/{project_id}/playlists/temp
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/playlists/temp' \
--header "Authorization: $API_KEY"Download a movie preview.
It stores the preview file and generates three picture files matching preview when it's possible: a square thumbnail, a rectangle thumbnail and a midsize file.
Path parameters
-
instance_id
Required
GET
/movies/originals/preview-files/{instance_id}.mp4
curl \
--request GET 'http://api.example.com/movies/originals/preview-files/{instance_id}.mp4' \
--header "Authorization: $API_KEY"Path parameters
-
instance_id
Required
GET
/pictures/previews/preview-files/{instance_id}.png
curl \
--request GET 'http://api.example.com/pictures/previews/preview-files/{instance_id}.png' \
--header "Authorization: $API_KEY"Create a thumbnail for given object instance.
Path parameters
-
instance_id
Required
POST
/pictures/thumbnails/projects/{instance_id}
curl \
--request POST 'http://api.example.com/pictures/thumbnails/projects/{instance_id}' \
--header "Authorization: $API_KEY"Add a preview background file linked to a production.
Path parameters
-
project_id
Required
POST
/data/projects/{project_id}/settings/preview-background-files
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/settings/preview-background-files' \
--header "Authorization: $API_KEY"Get all metadata descriptors
It serves to describe extra fields listed in the data attribute of entities.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/metadata-descriptors
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/metadata-descriptors' \
--header "Authorization: $API_KEY"Retrieve milestones for given production
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/milestones
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/milestones' \
--header "Authorization: $API_KEY"Retrieve a budget for given production
Path parameters
-
project_id
Required -
budget_id
Required
GET
/data/projects/{project_id}/budgets/{budget_id}
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/budgets/{budget_id}' \
--header "Authorization: $API_KEY"Retrieve all task types related to a given shot.
Path parameters
-
shot_id
Required
GET
/data/shots/{shot_id}/task-types
curl \
--request GET 'http://api.example.com/data/shots/{shot_id}/task-types' \
--header "Authorization: $API_KEY"Path parameters
-
scene_id
Required
GET
/data/scenes/{scene_id}/tasks
curl \
--request GET 'http://api.example.com/data/scenes/{scene_id}/tasks' \
--header "Authorization: $API_KEY"Retrieve all shots related to a given episode.
Path parameters
-
episode_id
Required
GET
/data/episodes/{episode_id}/shots
curl \
--request GET 'http://api.example.com/data/episodes/{episode_id}/shots' \
--header "Authorization: $API_KEY"Path parameters
-
sequence_id
Required
GET
/data/sequences/{sequence_id}
curl \
--request GET 'http://api.example.com/data/sequences/{sequence_id}' \
--header "Authorization: $API_KEY"Path parameters
-
sequence_id
Required
DELETE
/data/sequences/{sequence_id}
curl \
--request DELETE 'http://api.example.com/data/sequences/{sequence_id}' \
--header "Authorization: $API_KEY"Retrieve all scenes related to a given sequence.
Path parameters
-
sequence_id
Required
GET
/data/sequences/{sequence_id}/scenes
curl \
--request GET 'http://api.example.com/data/sequences/{sequence_id}/scenes' \
--header "Authorization: $API_KEY"Retrieve all tasks related to a given shot.
Path parameters
-
sequence_id
Required
GET
/data/sequences/{sequence_id}/tasks
curl \
--request GET 'http://api.example.com/data/sequences/{sequence_id}/tasks' \
--header "Authorization: $API_KEY"Path parameters
-
project_id
Required
POST
/data/projects/{project_id}/shots
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/shots' \
--header "Authorization: $API_KEY"Retrieve quotas statistics for shots.
Path parameters
-
project_id
Required -
task_type_id
Required
Query parameters
-
count_mode
Required
GET
/data/projects/{project_id}/quotas/{task_type_id}
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/quotas/{task_type_id}' \
--header "Authorization: $API_KEY"Retrieve quotas statistics for shots.
Path parameters
-
project_id
Required -
person_id
Required
Query parameters
-
count_mode
Required
GET
/data/projects/{project_id}/quotas/persons/{person_id}
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/quotas/persons/{person_id}' \
--header "Authorization: $API_KEY"Return task assigned to given user of which status has is_done flag sets to true.
It return only tasks related to open projects.
Path parameters
-
person_id
Required
GET
/data/persons/{person_id}/done-tasks
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/done-tasks' \
--header "Authorization: $API_KEY"Preview files related to a given project.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/preview-files
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/preview-files' \
--header "Authorization: $API_KEY"Delete all tasks for a given task type and project.
It's mainly used when tasks are created by mistake at the beginning of the project.
Path parameters
-
project_id
Required -
task_type_id
Required
DELETE
/actions/projects/{project_id}/task-types/{task_type_id}/delete-tasks
curl \
--request DELETE 'http://api.example.com/actions/projects/{project_id}/task-types/{task_type_id}/delete-tasks' \
--header "Authorization: $API_KEY"Create a new task for given shot and task type.
Path parameters
-
project_id
Required -
task_type_id
Required
POST
/actions/projects/{project_id}/task-types/{task_type_id}/shots/create-tasks
curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/task-types/{task_type_id}/shots/create-tasks' \
--header "Authorization: $API_KEY"Return shots related to given sequence if the current user has access
to it.
Path parameters
-
sequence_id
Required
GET
/data/user/sequences/{sequence_id}/shots
curl \
--request GET 'http://api.example.com/data/user/sequences/{sequence_id}/shots' \
--header "Authorization: $API_KEY"Retrieve filters for current user and only for open projects.
GET
/data/user/filters
curl \
--request GET 'http://api.example.com/data/user/filters' \
--header "Authorization: $API_KEY"
GET
/data/user/desktop-login-logs
curl \
--request GET 'http://api.example.com/data/user/desktop-login-logs' \
--header "Authorization: $API_KEY"
GET
/data/user/chats
curl \
--request GET 'http://api.example.com/data/user/chats' \
--header "Authorization: $API_KEY"Create a subscription entry for given task and current user.
When a user subscribes, he gets notified everytime a comment is posted on the task.
Path parameters
-
task_id
Required
POST
/actions/user/tasks/{task_id}/subscribe
curl \
--request POST 'http://api.example.com/actions/user/tasks/{task_id}/subscribe' \
--header "Authorization: $API_KEY"Set `has_avatar` flag to False for current user and remove its avatar
file.
DELETE
/actions/user/clear-avatar
curl \
--request DELETE 'http://api.example.com/actions/user/clear-avatar' \
--header "Authorization: $API_KEY"Return the list of sequence ids to which the current user has
subscribed for given task type.
Path parameters
-
project_id
Required -
task_type_id
Required
GET
/data/user/projects/{project_id}/task-types/{task_type_id}/sequence-subscriptions
curl \
--request GET 'http://api.example.com/data/user/projects/{project_id}/task-types/{task_type_id}/sequence-subscriptions' \
--header "Authorization: $API_KEY"Delete chat message.
Path parameters
-
entity_id
Required ID of the entity related to the chat
-
chat_message_id
Required ID of the chat message
DELETE
/data/entities/{entity_id}/chat/messages/{chat_message_id}
curl \
--request DELETE 'http://api.example.com/data/entities/{entity_id}/chat/messages/{chat_message_id}' \
--header "Authorization: $API_KEY"Set last preview from given task as main preview of the related entity.
This preview will be used as thumbnail to illustrate the entity.
Path parameters
-
preview_file_id
Required
PUT
/actions/tasks/{task_id}/set-main-preview
curl \
--request PUT 'http://api.example.com/actions/tasks/{task_id}/set-main-preview' \
--header "Authorization: $API_KEY"Main resource to add a preview background file.
Path parameters
-
instance_id
Required
POST
/pictures/preview-background-files/{instance_id}
curl \
--request POST 'http://api.example.com/pictures/preview-background-files/{instance_id}' \
--header "Authorization: $API_KEY"