Log user out by revoking his auth tokens.

GET /auth/logout
Jwt authorization

Once logged out, current user cannot access the API anymore.

Responses

  • 200

    Logout successful

  • 500

    Access token not found

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

Retrieve all asset types of assets casted in given shot.

GET /data/shots/{shot_id}/asset-types
Jwt authorization

Path parameters

  • shot_id Required

Responses

  • 200

    All asset types of assets casted in given shot

GET /data/shots/{shot_id}/asset-types 
curl \
 --request GET 'http://api.example.com/data/shots/{shot_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
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/{project_id}/entities/{entity_id}/casting' \
 --header "Authorization: $API_KEY"

Delete attachment linked to a comment matching given ID.

DELETE /data/tasks/{task_id}/comments/{comment_id}/attachments/{attachment_id}
Jwt authorization

Path parameters

  • task_id Required
  • comment_id Required
  • attachment_id Required

Responses

  • 204

    Empty response

DELETE /data/tasks/{task_id}/comments/{comment_id}/attachments/{attachment_id} 
curl \
 --request DELETE 'http://api.example.com/data/tasks/{task_id}/comments/{comment_id}/attachments/{attachment_id}' \
 --header "Authorization: $API_KEY"

Delete given comment reply.

DELETE /data/tasks/{task_id}/comments/{comment_id}/reply/{reply_id}
Jwt authorization

Path parameters

  • task_id Required
  • comment_id Required
  • reply_id Required

Responses

  • 200

    Given comment reply deleted

DELETE /data/tasks/{task_id}/comments/{comment_id}/reply/{reply_id} 
curl \
 --request DELETE 'http://api.example.com/data/tasks/{task_id}/comments/{comment_id}/reply/{reply_id}' \
 --header "Authorization: $API_KEY"

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

DELETE /data/entities/{instance_id}
Jwt authorization

Path parameters

  • instance_id Required

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

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

DELETE /data/task-types/{instance_id}
Jwt authorization

Path parameters

  • instance_id Required

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

Retrieve all entries for given model.

GET /data/tasks
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/tasks 
curl \
 --request GET 'http://api.example.com/data/tasks' \
 --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 model corresponding at given ID and return it as a JSON object.

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

Path parameters

  • instance_id Required

Responses

  • 200

    Model as a JSON object

  • 400

    Statement error

  • 404

    Value error

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

Create a model with data given in the request body.

POST /data/working-files
Jwt authorization

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

Responses

  • 200

    Model created

  • 400

    Error

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

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

DELETE /data/day-offs/{instance_id}
Jwt authorization

Path parameters

  • instance_id Required

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

Create a model with data given in the request body.

POST /data/events/
Jwt authorization

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

Responses

  • 200

    Model created

  • 400

    Error

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

Update a model with data given in the request body.

PUT /data/events/{instance_id}
Jwt authorization

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

Path parameters

  • instance_id Required

Responses

  • 200

    Model updated

  • 400

    Error

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

Update a model with data given in the request body.

PUT /data/search-filters/{instance_id}
Jwt authorization

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

Path parameters

  • instance_id Required

Responses

  • 200

    Model updated

  • 400

    Error

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.

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

Path parameters

  • instance_id Required

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

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

GET /data/subscriptions/{instance_id}
Jwt authorization

Path parameters

  • instance_id Required

Responses

  • 200

    Model as a JSON object

  • 400

    Statement error

  • 404

    Value error

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/entity-links/
Jwt authorization

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 all entries for given model.

GET /data/studios
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/studios 
curl \
 --request GET 'http://api.example.com/data/studios' \
 --header "Authorization: $API_KEY"

Retrieve all tasks related to a given episode.

GET /data/episodes/{episode_id}/edit-tasks
Jwt authorization

Path parameters

  • episode_id Required

Responses

  • 200

    All tasks related to given episode

GET /data/episodes/{episode_id}/edit-tasks 
curl \
 --request GET 'http://api.example.com/data/episodes/{episode_id}/edit-tasks' \
 --header "Authorization: $API_KEY"

Export casting linked to a given project as csv.

GET /export/csv/projects/{project_id}/casting.csv
Jwt authorization

Path parameters

  • project_id Required

Responses

  • 200

    Casting exported as csv

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

Return last working files revision for each file name for given task.

GET /data/tasks/{task_id}/working-files/last-revisions
Jwt authorization

Path parameters

  • task_id Required

Responses

  • 200

    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"

Generate a working file path from file tree template.

POST /data/tasks/{task_id}/working-file-path
Jwt authorization

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

Responses

  • 200

    Working file path generated

  • 400

    Malformed file tree

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"

Import shotgun resource.

POST /import/shotgun/persons
Jwt authorization

Responses

  • 200

    Resource imported

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

Import shotgun resource.

POST /import/shotgun/projectconnections
Jwt authorization

Responses

  • 200

    Resource imported

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

Delete error.

DELETE /import/shotgun/errors/{error_id}
Jwt authorization

Path parameters

  • error_id Required

Responses

  • 204

    Error deleted

  • 404

    Error non-existant or Statement error

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

Import remove instance.

POST /import/shotgun/remove/shot
Jwt authorization

Responses

  • 204

    Instance removed

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

Return a table giving time spent by user and by month for given year.

GET /data/persons/time-spents/year-table/
Jwt authorization

Responses

  • 200

    Table giving time spent by user and by month for given year

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

Return all day off recorded for given week and person.

GET /data/persons/{person_id}/day-offs/week/{year}/{week}
Jwt authorization

Path parameters

  • person_id Required
  • year Required
  • week Required

Responses

  • 200

    All day off recorded for given week and person

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

Sends an email to given person to invite him/her to connect to Kitsu.

GET /actions/persons/{person_id}/invite
Jwt authorization

Path parameters

  • person_id Required

Responses

  • 200

    Email sent

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

Retrieve all build jobs related to given project.

GET /data/projects/{project_id}/build-jobs
Jwt authorization

It's mainly used for synchronisation purpose.

Path parameters

  • project_id Required

Responses

  • 200

    All build jobs related to given project

GET /data/projects/{project_id}/build-jobs 
curl \
 --request GET 'http://api.example.com/data/projects/{project_id}/build-jobs' \
 --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/{instance_id}.mp4' \
 --header "Authorization: $API_KEY"

Download a thumbnail.

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

Path parameters

  • instance_id Required

Responses

  • 200

    Thumbnail downloaded

  • 403

    Instance not allowed

  • 404

    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/projects/{instance_id}
Jwt authorization

Path parameters

  • instance_id Required

Responses

  • 200

    Thumbnail downloaded

  • 403

    Access not allowed

  • 404

    Object instance not found

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

Create a new metadata descriptor

POST /data/projects/{project_id}/metadata-descriptors
Jwt authorization

It serves to describe extra fields listed in the data attribute of entities.

Path parameters

  • project_id Required

Responses

  • 201

    Create a new metadata descriptor

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

Retrieve milestones for given production

GET /data/projects/{project_id}/milestones
Jwt authorization

Path parameters

  • project_id Required

Responses

  • 200

    All milestones of given production

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