Resource to allow a user to enable TOTP.

POST /auth/totp
Jwt authorization

Responses

  • 200

    TOTP enabled

  • 400

    Invalid password Wrong or expired token Inactive user

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

Retrieve the list of shots that cast given asset.

GET /data/assets/{asset_id}/cast-in
Jwt authorization

Path parameters

  • asset_id Required

Responses

  • 200

    List of shots that cast given asset

GET /data/assets/{asset_id}/cast-in 
curl \
 --request GET 'http://api.example.com/data/assets/a24a6ea4-ce75-4665-a070-57453082c25/cast-in' \
 --header "Authorization: $API_KEY"

Resource to retrieve the casting of a given entity.

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

Path parameters

  • project_id Required
  • entity_id Required

Responses

  • 200

    Casting of given entity

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

Retrieve all asset instances linked to scene.

GET /data/scenes/{scene_id}/asset-instances
Jwt authorization

Path parameters

  • scene_id Required

Responses

  • 200

    All asset instances linked to given scene

GET /data/scenes/{scene_id}/asset-instances 
curl \
 --request GET 'http://api.example.com/data/scenes/a24a6ea4-ce75-4665-a070-57453082c25/asset-instances' \
 --header "Authorization: $API_KEY"

Return all attachment files related to given task.

GET /data/tasks/{task_id}/attachment-files
Jwt authorization

Path parameters

  • task_id Required

Responses

  • 200

    All attachment files related to given task

GET /data/tasks/{task_id}/attachment-files 
curl \
 --request GET 'http://api.example.com/data/tasks/a24a6ea4-ce75-4665-a070-57453082c25/attachment-files' \
 --header "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/task-types
Jwt authorization

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

Responses

  • 200

    Model created

  • 400

    Error

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

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/departments/{instance_id}
Jwt authorization

Path parameters

  • instance_id Required

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/departments/{instance_id} 
curl \
 --request DELETE 'http://api.example.com/data/departments/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/file-status/
Jwt authorization

Filters can be specified in the query string.

Responses

  • 200

    All entries for given model

  • 400

    Format error

  • 403

    Permission denied

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

Retrieve a working file corresponding at given ID and return it as a

GET /data/working-files/{instance_id}
Jwt authorization

JSON object.

Path parameters

  • working_file_id Required

Responses

  • 200

    Model as a JSON object

  • 400

    Statement error

  • 404

    Value error

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

Create a model with data given in the request body.

POST /data/custom-actions/
Jwt authorization

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

Responses

  • 200

    Model created

  • 400

    Error

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

Retrieve a model corresponding at given ID and return it as a JSON object.

GET /data/asset-instances/{instance_id}
Jwt authorization

Path parameters

  • instance_id Required

Responses

  • 200

    Model as a JSON object

  • 400

    Statement error

  • 404

    Value error

GET /data/asset-instances/{instance_id} 
curl \
 --request GET 'http://api.example.com/data/asset-instances/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/search-filter-groups/
Jwt authorization

Filters can be specified in the query string.

Responses

  • 200

    All entries for given model

  • 400

    Format error

  • 403

    Permission denied

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

Retrieve a model corresponding at given ID and return it as a JSON object.

GET /data/search-filter-groups/{instance_id}
Jwt authorization

Path parameters

  • instance_id Required

Responses

  • 200

    Model as a JSON object

  • 400

    Statement error

  • 404

    Value error

GET /data/search-filter-groups/{instance_id} 
curl \
 --request GET 'http://api.example.com/data/search-filter-groups/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/news/{instance_id}
Jwt authorization

Path parameters

  • instance_id Required

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/news/{instance_id} 
curl \
 --request DELETE 'http://api.example.com/data/news/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/studios
Jwt authorization

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

Responses

  • 200

    Model created

  • 400

    Error

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

Retrieve all entries for given model.

GET /data/plugins
Jwt authorization

Filters can be specified in the query string.

Responses

  • 200

    All entries for given model

  • 400

    Format error

  • 403

    Permission denied

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

Create a model with data given in the request body.

POST /data/plugins
Jwt authorization

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

Responses

  • 200

    Model created

  • 400

    Error

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

Retrieve all entries for given model.

GET /data/production-schedule-versions
Jwt authorization

Filters can be specified in the query string.

Responses

  • 200

    All entries for given model

  • 400

    Format error

  • 403

    Permission denied

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

Create a model with data given in the request body.

POST /data/production-schedule-versions
Jwt authorization

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

Responses

  • 200

    Model created

  • 400

    Error

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

Add a software item to given department.

POST /data/departments/{department_id}/software-licenses
Jwt authorization

Path parameters

  • department_id Required

Responses

  • 201

    User added to given department

  • 404

    Department ID or Software ID matches no department or software

POST /data/departments/{department_id}/software-licenses 
curl \
 --request POST 'http://api.example.com/data/departments/a24a6ea4-ce75-4665-a070-57453082c25/software-licenses' \
 --header "Authorization: $API_KEY"

Get next revision for given asset instance, output type, task type and name.

POST /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/next-revision
Jwt authorization

Path parameters

  • asset_instance_id Required
  • temporal_entity_id Required

Responses

  • 200

    Next revision for given asset instance, output type, task type and name

POST /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/next-revision 
curl \
 --request POST 'http://api.example.com/data/asset-instances/a24a6ea4-ce75-4665-a070-57453082c25/entities/a24a6ea4-ce75-4665-a070-57453082c25/output-files/next-revision' \
 --header "Authorization: $API_KEY"

Get all output files for given asset instance and given output type.

GET /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types/{output_type_id}/output-files
Jwt authorization

Path parameters

  • asset_instance_id Required
  • temporal_entity_id Required
  • output_type_id Required

Responses

  • 200

    All output files for given asset instance and given output type

GET /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types/{output_type_id}/output-files 
curl \
 --request GET 'http://api.example.com/data/asset-instances/a24a6ea4-ce75-4665-a070-57453082c25/entities/a24a6ea4-ce75-4665-a070-57453082c25/output-types/a24a6ea4-ce75-4665-a070-57453082c25/output-files' \
 --header "Authorization: $API_KEY"

Return all types of output generated for given entity.

GET /data/entities/{entity_id}/output-types
Jwt authorization

Path parameters

  • entity_id Required

Responses

  • 200

    All types of output generated for given entity

GET /data/entities/{entity_id}/output-types 
curl \
 --request GET 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/output-types' \
 --header "Authorization: $API_KEY"

Import shotgun error resource.

GET /import/shotgun/errors
Jwt authorization

Responses

  • 200

    Resource imported

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

Get basic configuration for the current instance.

GET /config
Jwt authorization

Responses

  • 200

    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"

News

Persons

Get aggregated time spents for given person and year.

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

Path parameters

  • person_id Required
  • year Required

Responses

  • 200

    Aggregated time spents for given person and year

  • 404

    Wrong date format

GET /data/persons/{person_id}/time-spents/year/{year} 
curl \
 --request GET 'http://api.example.com/data/persons/a24a6ea4-ce75-4665-a070-57453082c25/time-spents/year/2022' \
 --header "Authorization: $API_KEY"

Remove given build job related to given playlist.

DELETE /data/playlists/{playlist_id}/jobs/{build_job_id}
Jwt authorization

Path parameters

  • playlist_id Required
  • build_job_id Required

Responses

  • 204

    Given build job removed

DELETE /data/playlists/{playlist_id}/jobs/{build_job_id} 
curl \
 --request DELETE 'http://api.example.com/data/playlists/a24a6ea4-ce75-4665-a070-57453082c25/jobs/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Download a lowdef movie preview.

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

Path parameters

  • instance_id Required

Responses

  • 200

    Lowdef movie preview downloaded

  • 403

    Instance not allowed

  • 404

    File not found

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

Get a status automation linked to a production.

GET /data/projects/{project_id}/settings/status-automations
Jwt authorization

Path parameters

  • project_id Required

Responses

  • 200

    Status automation linked to production

GET /data/projects/{project_id}/settings/status-automations 
curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/settings/status-automations' \
 --header "Authorization: $API_KEY"

Get aggregated time spents by month for given project.

GET /data/projects/{project_id}/budgets/time-spents
Jwt authorization

Path parameters

  • project_id Required

Responses

  • 200

    Aggregated time spents for given person and month

  • 400

    Wrong ID format

GET /data/projects/{project_id}/budgets/time-spents 
curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/budgets/time-spents' \
 --header "Authorization: $API_KEY"

Shots

Retrieve all sequence entries for a given episode.

GET /data/episodes/{episode_id}/sequences
Jwt authorization

Filters can be specified in the query string.

Path parameters

  • episode_id Required

Query parameters

  • project_id

Responses

  • 200

    All sequence entries for given episode

GET /data/episodes/{episode_id}/sequences 
curl \
 --request GET 'http://api.example.com/data/episodes/a24a6ea4-ce75-4665-a070-57453082c25/sequences' \
 --header "Authorization: $API_KEY"

Retrieve all task types related to a given episode.

GET /data/episodes/{episode_id}/task-types
Jwt authorization

Path parameters

  • episode_id Required

Responses

  • 200

    All task types related to given episode

GET /data/episodes/{episode_id}/task-types 
curl \
 --request GET 'http://api.example.com/data/episodes/a24a6ea4-ce75-4665-a070-57453082c25/task-types' \
 --header "Authorization: $API_KEY"

Retrieve all task types related to a given shot.

GET /data/sequences/{sequence_id}/task-types
Jwt authorization

Path parameters

  • sequence_id Required

Responses

  • 200

    All task types related to given shot

GET /data/sequences/{sequence_id}/task-types 
curl \
 --request GET 'http://api.example.com/data/sequences/a24a6ea4-ce75-4665-a070-57453082c25/task-types' \
 --header "Authorization: $API_KEY"

Return task assigned to given user of which status has is_done flag sets to true.

GET /data/persons/{person_id}/done-tasks
Jwt authorization

It return only tasks related to open projects.

Path parameters

  • person_id string(uuid) Required

Responses

  • 200 application/json

    Tasks assigned to user that are done
  • 404

    Person not found

GET /data/persons/{person_id}/done-tasks 
curl \
 --request GET 'http://api.example.com/data/persons/a24a6ea4-ce75-4665-a070-57453082c25/done-tasks' \
 --header "Authorization: $API_KEY"
Response examples (200) 
[
  {}
]

Preview files related to a given project.

GET /data/projects/{project_id}/preview-files
Jwt authorization

Path parameters

  • project_id string Required

Responses

  • 200

    Preview files related to given project

GET /data/projects/{project_id}/preview-files 
curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/preview-files' \
 --header "Authorization: $API_KEY"

Return tasks related to given scene for current user.

GET /data/user/scenes/{scene_id}/tasks
Jwt authorization

Path parameters

  • scene_id string(uuid) Required

Responses

  • 200 application/json

    Tasks related to given scene
  • 404

    Scene not found

GET /data/user/scenes/{scene_id}/tasks 
curl \
 --request GET 'http://api.example.com/data/user/scenes/a24a6ea4-ce75-4665-a070-57453082c25/tasks' \
 --header "Authorization: $API_KEY"
Response examples (200) 
[
  {}
]

Return asset types related to given project if the current user has

GET /data/user/projects/{project_id}/asset-types
Jwt authorization

access to it.

Path parameters

  • project_id string(uuid) Required

Responses

  • 200 application/json

    Asset types related to given project
  • 404

    Project not found

GET /data/user/projects/{project_id}/asset-types 
curl \
 --request GET 'http://api.example.com/data/user/projects/a24a6ea4-ce75-4665-a070-57453082c25/asset-types' \
 --header "Authorization: $API_KEY"
Response examples (200) 
[
  {}
]

Return tasks currently assigned to current user and of which status has

GET /data/user/tasks
Jwt authorization

is_done attribute set to false.

Responses

  • 200 application/json

    Unfinished tasks currently assigned to current user
GET /data/user/tasks 
curl \
 --request GET 'http://api.example.com/data/user/tasks' \
 --header "Authorization: $API_KEY"
Response examples (200) 
[
  {}
]

Delete given filter group if it's owned by the current user.

DELETE /data/user/filter-groups/{filter_group_id}
Jwt authorization

Path parameters

  • filter_id Required

Responses

  • 204

    Empty response

DELETE /data/user/filter-groups/{filter_group_id} 
curl \
 --request DELETE 'http://api.example.com/data/user/filter-groups/{filter_group_id}' \
 --header "Authorization: $API_KEY"

Join chat for given entity (be listed as participant).

POST /actions/user/chats/{entity_id}/join
Jwt authorization

Path parameters

  • entity_id string(uuid) Required

Responses

  • 201 application/json

    Chat joined
  • 404

    Entity not found

POST /actions/user/chats/{entity_id}/join 
curl \
 --request POST 'http://api.example.com/actions/user/chats/a24a6ea4-ce75-4665-a070-57453082c25/join' \
 --header "Authorization: $API_KEY"
Response examples (201) 
{}