Responses

  • OTP by email enabled

  • Invalid password Wrong or expired token Inactive user

POST /auth/email-otp
curl \
 --request POST 'http://api.example.com/auth/email-otp' \
 --header "Authorization: $API_KEY"
































GET /data/asset-types
curl \
 --request GET 'http://api.example.com/data/asset-types' \
 --header "Authorization: $API_KEY"








































GET /data/assets/{asset_id}/casting
curl \
 --request GET 'http://api.example.com/data/assets/{asset_id}/casting' \
 --header "Authorization: $API_KEY"

Responses

  • Modification of assets linked to given asset

PUT /data/assets/{asset_id}/casting
curl \
 --request PUT 'http://api.example.com/data/assets/{asset_id}/casting' \
 --header "Authorization: $API_KEY"
























Retrieve all asset types for given project.

GET /data/projects/{project_id}/asset-types

Responses

  • All asset types for given project

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 a given entity.

GET /data/projects/{project_id}/entities/{entity_id}/casting

Responses

  • Casting of given entity

GET /data/projects/{project_id}/entities/{entity_id}/casting
curl \
 --request GET 'http://api.example.com/data/projects/{project_id}/entities/{entity_id}/casting' \
 --header "Authorization: $API_KEY"

Resource to allow the modification of assets linked to an entity.

PUT /data/projects/{project_id}/entities/{entity_id}/casting

Responses

  • Modification of assets linked to an entity

PUT /data/projects/{project_id}/entities/{entity_id}/casting
curl \
 --request PUT 'http://api.example.com/data/projects/{project_id}/entities/{entity_id}/casting' \
 --header "Authorization: $API_KEY"




GET /data/projects/{project_id}/episodes/casting
curl \
 --request GET 'http://api.example.com/data/projects/{project_id}/episodes/casting' \
 --header "Authorization: $API_KEY"
































Responses

  • All assets linked to shot

GET /data/shots/{shot_id}/asset-instances
curl \
 --request GET 'http://api.example.com/data/shots/{shot_id}/asset-instances' \
 --header "Authorization: $API_KEY"

























Download attachment file.

GET /data/attachment-files/{attachment_file_id}/file/{file_name}

Responses

  • Attachment file downloaded

  • Download failed

GET /data/attachment-files/{attachment_file_id}/file/{file_name}
curl \
 --request GET 'http://api.example.com/data/attachment-files/{attachment_file_id}/file/{file_name}' \
 --header "Authorization: $API_KEY"












Create a new comment for given task.

POST /actions/tasks/{task_id}/comment

It requires a text, 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

Responses

  • New comment created

POST /actions/tasks/{task_id}/comment
curl \
 --request POST 'http://api.example.com/actions/tasks/{task_id}/comment' \
 --header "Authorization: $API_KEY"













Retrieve all entries for given model.

GET /data/persons

Filters can be specified in the query string.

Responses

GET /data/persons
curl \
 --request GET 'http://api.example.com/data/persons' \
 --header "Authorization: $API_KEY"








Update a model with data given in the request body.

PUT /data/persons/{instance_id}

JSON format is expected. Model performs the validation automatically when fields are modified.

Responses

PUT /data/persons/{instance_id}
curl \
 --request PUT 'http://api.example.com/data/persons/{instance_id}' \
 --header "Authorization: $API_KEY"












Update a model with data given in the request body.

PUT /data/projects/{instance_id}

JSON format is expected. Model performs the validation automatically when fields are modified.

Responses

PUT /data/projects/{instance_id}
curl \
 --request PUT 'http://api.example.com/data/projects/{instance_id}' \
 --header "Authorization: $API_KEY"












































































































































GET /data/organisations/{instance_id}
curl \
 --request GET 'http://api.example.com/data/organisations/{instance_id}' \
 --header "Authorization: $API_KEY"




Responses

  • Model deleted

  • Statement or integrity error

  • Instance non-existant

DELETE /data/organisations/{instance_id}
curl \
 --request DELETE 'http://api.example.com/data/organisations/{instance_id}' \
 --header "Authorization: $API_KEY"




























































































































Create a model with data given in the request body.

POST /data/attachment-files

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

POST /data/attachment-files
curl \
 --request POST 'http://api.example.com/data/attachment-files' \
 --header "Authorization: $API_KEY"




Update a model with data given in the request body.

PUT /data/attachment-files/{instance_id}

JSON format is expected. Model performs the validation automatically when fields are modified.

Responses

PUT /data/attachment-files/{instance_id}
curl \
 --request PUT 'http://api.example.com/data/attachment-files/{instance_id}' \
 --header "Authorization: $API_KEY"




































Responses

  • Model deleted

  • Statement or integrity error

  • Instance non-existant

DELETE /data/time-spents/{instance_id}
curl \
 --request DELETE 'http://api.example.com/data/time-spents/{instance_id}' \
 --header "Authorization: $API_KEY"








































Retrieve all entries for given model.

GET /data/status-automations/

Filters can be specified in the query string.

Responses

GET /data/status-automations/
curl \
 --request GET 'http://api.example.com/data/status-automations/' \
 --header "Authorization: $API_KEY"
























































Create a model with data given in the request body.

POST /data/events/

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

POST /data/events/
curl \
 --request POST 'http://api.example.com/data/events/' \
 --header "Authorization: $API_KEY"




















GET /data/notifications/{instance_id}
curl \
 --request GET 'http://api.example.com/data/notifications/{instance_id}' \
 --header "Authorization: $API_KEY"












Create a model with data given in the request body.

POST /data/search-filters/

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

POST /data/search-filters/
curl \
 --request POST 'http://api.example.com/data/search-filters/' \
 --header "Authorization: $API_KEY"












Retrieve all entries for given model.

GET /data/search-filter-groups/

Filters can be specified in the query string.

Responses

GET /data/search-filter-groups/
curl \
 --request GET 'http://api.example.com/data/search-filter-groups/' \
 --header "Authorization: $API_KEY"
















































Update a model with data given in the request body.

PUT /data/news/{instance_id}

JSON format is expected. Model performs the validation automatically when fields are modified.

Responses

PUT /data/news/{instance_id}
curl \
 --request PUT 'http://api.example.com/data/news/{instance_id}' \
 --header "Authorization: $API_KEY"
DELETE /data/news/{instance_id}
curl \
 --request DELETE 'http://api.example.com/data/news/{instance_id}' \
 --header "Authorization: $API_KEY"




























GET /data/metadata-descriptors/{instance_id}
curl \
 --request GET 'http://api.example.com/data/metadata-descriptors/{instance_id}' \
 --header "Authorization: $API_KEY"
















GET /data/subscriptions/{instance_id}
curl \
 --request GET 'http://api.example.com/data/subscriptions/{instance_id}' \
 --header "Authorization: $API_KEY"




























Retrieve all entries for given model.

GET /data/chats/

Filters can be specified in the query string.

Responses

GET /data/chats/
curl \
 --request GET 'http://api.example.com/data/chats/' \
 --header "Authorization: $API_KEY"




















Create a model with data given in the request body.

POST /data/chat-messages/

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

POST /data/chat-messages/
curl \
 --request POST 'http://api.example.com/data/chat-messages/' \
 --header "Authorization: $API_KEY"













































































































DELETE /data/edits/{edit_id}
curl \
 --request DELETE 'http://api.example.com/data/edits/{edit_id}' \
 --header "Authorization: $API_KEY"












Responses

  • Data versions of given edit

GET /data/edits/{edit_id}/versions
curl \
 --request GET 'http://api.example.com/data/edits/{edit_id}/versions' \
 --header "Authorization: $API_KEY"

















Responses

  • All news linked to given entity

GET /data/entities/{entity_id}/news
curl \
 --request GET 'http://api.example.com/data/entities/{entity_id}/news' \
 --header "Authorization: $API_KEY"


















Export assets linked to a given project as csv.

GET /export/csv/projects/{project_id}/assets.csv

Responses

  • Assets exported as csv

GET /export/csv/projects/{project_id}/assets.csv
curl \
 --request GET 'http://api.example.com/export/csv/projects/{project_id}/assets.csv' \
 --header "Authorization: $API_KEY"








GET /export/csv/projects/{project_id}/edits.csv
curl \
 --request GET 'http://api.example.com/export/csv/projects/{project_id}/edits.csv' \
 --header "Authorization: $API_KEY"





























Responses

  • Last working files revision for each file name for given task

GET /data/tasks/{task_id}/working-files
curl \
 --request GET 'http://api.example.com/data/tasks/{task_id}/working-files' \
 --header "Authorization: $API_KEY"




Responses

  • Last working files revision for each file name for given task

GET /data/tasks/{task_id}/working-files/last-revisions
curl \
 --request GET 'http://api.example.com/data/tasks/{task_id}/working-files/last-revisions' \
 --header "Authorization: $API_KEY"








































Responses

  • Last revisions of output files for given entity grouped by output type and file name

GET /data/entities/{entity_id}/output-files/last-revisions
curl \
 --request GET 'http://api.example.com/data/entities/{entity_id}/output-files/last-revisions' \
 --header "Authorization: $API_KEY"
























Download a working file.

GET /data/working-files/{working_file_id}/file

Responses

  • Working file downloaded

GET /data/working-files/{working_file_id}/file
curl \
 --request GET 'http://api.example.com/data/working-files/{working_file_id}/file' \
 --header "Authorization: $API_KEY"

























Responses

POST /import/shotgun/episodes
curl \
 --request POST 'http://api.example.com/import/shotgun/episodes' \
 --header "Authorization: $API_KEY"








































POST /import/shotgun/errors
curl \
 --request POST 'http://api.example.com/import/shotgun/errors' \
 --header "Authorization: $API_KEY"




























Import remove instance.

POST /import/shotgun/remove/sequence

Responses

POST /import/shotgun/remove/sequence
curl \
 --request POST 'http://api.example.com/import/shotgun/remove/sequence' \
 --header "Authorization: $API_KEY"




Import remove instance.

POST /import/shotgun/remove/projectconnection

Responses

POST /import/shotgun/remove/projectconnection
curl \
 --request POST 'http://api.example.com/import/shotgun/remove/projectconnection' \
 --header "Authorization: $API_KEY"




Import remove instance.

POST /import/shotgun/remove/status

Responses

POST /import/shotgun/remove/status
curl \
 --request POST 'http://api.example.com/import/shotgun/remove/status' \
 --header "Authorization: $API_KEY"












Responses

  • The lists of imported persons.

  • The .csv file is not properly formatted.

POST /import/csv/persons
curl \
 --request POST 'http://api.example.com/import/csv/persons' \
 --header "Authorization: $API_KEY"








































Import Kitsu resource.

POST /import/kitsu/entity-links

Responses

POST /import/kitsu/entity-links
curl \
 --request POST 'http://api.example.com/import/kitsu/entity-links' \
 --header "Authorization: $API_KEY"









GET /
curl \
 --request GET 'http://api.example.com/' \
 --header "Authorization: $API_KEY"
GET /status
curl \
 --request GET 'http://api.example.com/status' \
 --header "Authorization: $API_KEY"




















Responses

  • Configuration object including self-hosted status, Crisp token, indexer configuration, SAML status, and dark theme status.

GET /config
curl \
 --request GET 'http://api.example.com/config' \
 --header "Authorization: $API_KEY"


































Get aggregated time spents for given person and year.

GET /data/persons/{person_id}/time-spents/year/{year}

Responses

  • Aggregated time spents for given person and year

  • Wrong date format

GET /data/persons/{person_id}/time-spents/year/{year}
curl \
 --request GET 'http://api.example.com/data/persons/{person_id}/time-spents/year/{year}' \
 --header "Authorization: $API_KEY"
















Get ended shots used for quota calculation of this week.

GET /data/persons/{person_id}/quota-shots/week/{year}/{week}

Responses

  • Ended shots used for quota calculation of this week

  • Wrong date format

GET /data/persons/{person_id}/quota-shots/week/{year}/{week}
curl \
 --request GET 'http://api.example.com/data/persons/{person_id}/quota-shots/week/{year}/{week}' \
 --header "Authorization: $API_KEY"








































GET /actions/persons/{person_id}/invite
curl \
 --request GET 'http://api.example.com/actions/persons/{person_id}/invite' \
 --header "Authorization: $API_KEY"

Add a user to given department.

POST /actions/persons/{person_id}/departments/add

Path parameters

Responses

  • User added to given department

POST /actions/persons/{person_id}/departments/add
curl \
 --request POST 'http://api.example.com/actions/persons/{person_id}/departments/add' \
 --header "Authorization: $API_KEY"








Allow admin to disable two factor authentication for given user.

DELETE /actions/persons/{person_id}/disable-two-factor-authentication

Prior to disable two factor authentication, it requires to be admin. An admin can't disable two factor authentication for other admins.

Responses

  • Two factor authentication disabled

  • Inactive user

DELETE /actions/persons/{person_id}/disable-two-factor-authentication
curl \
 --request DELETE 'http://api.example.com/actions/persons/{person_id}/disable-two-factor-authentication' \
 --header "Authorization: $API_KEY"




Retrieve all playlists related to given project.

GET /data/projects/{project_id}/playlists/all

It's mainly used for synchronisation purpose.

Responses

  • All playlists related to given project

GET /data/projects/{project_id}/playlists/all
curl \
 --request GET 'http://api.example.com/data/projects/{project_id}/playlists/all' \
 --header "Authorization: $API_KEY"












Retrieve build job related to given playlist.

GET /data/playlists/{playlist_id}/jobs/{build_job_id}

Responses

  • Build job related to given playlist

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"

































Download a movie preview.

GET /movies/originals/preview-files/{instance_id}.mp4

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.

Responses

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"




Download a lowdef movie preview.

GET /movies/low/preview-files/{instance_id}.mp4

Responses

  • Lowdef movie preview downloaded

  • Instance not allowed

  • File not found

GET /movies/low/preview-files/{instance_id}.mp4
curl \
 --request GET 'http://api.example.com/movies/low/preview-files/{instance_id}.mp4' \
 --header "Authorization: $API_KEY"

Download a thumbnail.

GET /pictures/thumbnails/preview-files/{instance_id}.png

Responses

  • Thumbnail downloaded

  • Instance not allowed

  • Picture file not found

GET /pictures/thumbnails/preview-files/{instance_id}.png
curl \
 --request GET 'http://api.example.com/pictures/thumbnails/preview-files/{instance_id}.png' \
 --header "Authorization: $API_KEY"




































Download the thumbnail linked to given object instance.

GET /pictures/thumbnails/organisations/{instance_id}.png

Responses

  • Thumbnail downloaded

  • Access not allowed

  • Object instance not found

GET /pictures/thumbnails/organisations/{instance_id}.png
curl \
 --request GET 'http://api.example.com/pictures/thumbnails/organisations/{instance_id}.png' \
 --header "Authorization: $API_KEY"
















Create a thumbnail for given object instance.

POST /pictures/thumbnails/persons/{instance_id}.png

Path parameters

Responses

  • Thumbnail created

  • Cannot found related object.

POST /pictures/thumbnails/persons/{instance_id}.png
curl \
 --request POST 'http://api.example.com/pictures/thumbnails/persons/{instance_id}.png' \
 --header "Authorization: $API_KEY"




























Set given preview as main preview of the related entity.

PUT /actions/preview-files/{preview_file_id}/set-main-preview

This preview will be used to illustrate the entity.

Responses

  • Given preview set as main preview

PUT /actions/preview-files/{preview_file_id}/set-main-preview
curl \
 --request PUT 'http://api.example.com/actions/preview-files/{preview_file_id}/set-main-preview' \
 --header "Authorization: $API_KEY"





















































Return task statuses linked to a production

GET /data/projects/{project_id}/settings/task-status

Responses

  • Task statuses linked to production

GET /data/projects/{project_id}/settings/task-status
curl \
 --request GET 'http://api.example.com/data/projects/{project_id}/settings/task-status' \
 --header "Authorization: $API_KEY"
























Return preview background files linked to a production

GET /data/projects/{project_id}/settings/preview-background-files

Responses

  • Preview background files linked to production

GET /data/projects/{project_id}/settings/preview-background-files
curl \
 --request GET 'http://api.example.com/data/projects/{project_id}/settings/preview-background-files' \
 --header "Authorization: $API_KEY"
























































POST /data/projects/{project_id}/budgets
curl \
 --request POST 'http://api.example.com/data/projects/{project_id}/budgets' \
 --header "Authorization: $API_KEY"














































































































Delete given shot from given scene.

DELETE /data/scenes/{scene_id}/shots/{shot_id}

Responses

  • Given shot deleted from given scene

DELETE /data/scenes/{scene_id}/shots/{shot_id}
curl \
 --request DELETE 'http://api.example.com/data/scenes/{scene_id}/shots/{shot_id}' \
 --header "Authorization: $API_KEY"
















































































































































































































Responses

  • All assignations removed

PUT /actions/tasks/clear-assignation
curl \
 --request PUT 'http://api.example.com/actions/tasks/clear-assignation' \
 --header "Authorization: $API_KEY"








































Create a new task for given shot and task type.

POST /actions/projects/{project_id}/task-types/{task_type_id}/shots/create-tasks

Path parameters

Responses

  • New task for given shot and task type created

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"








Create a new task for given concept and task type.

POST /actions/projects/{project_id}/task-types/{task_type_id}/concepts/create-tasks

Path parameters

Responses

  • New task for given concept and task type created

POST /actions/projects/{project_id}/task-types/{task_type_id}/concepts/create-tasks
curl \
 --request POST 'http://api.example.com/actions/projects/{project_id}/task-types/{task_type_id}/concepts/create-tasks' \
 --header "Authorization: $API_KEY"













































Responses

  • Open projects for which the user has at least one task assigned

GET /data/user/projects/open
curl \
 --request GET 'http://api.example.com/data/user/projects/open' \
 --header "Authorization: $API_KEY"












































PUT /data/user/filters/{filter_id}
curl \
 --request PUT 'http://api.example.com/data/user/filters/{filter_id}' \
 --header "Authorization: $API_KEY"





































































































Get chat details.

GET /data/entities/{entity_id}/chat

Path parameters

  • entity_id Required

    ID of the entity related to the chat

Responses

GET /data/entities/{entity_id}/chat
curl \
 --request GET 'http://api.example.com/data/entities/{entity_id}/chat' \
 --header "Authorization: $API_KEY"