Kitsu API logo
API Changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Read the installation documentation

Topics

  • Introduction
  • Authentication

Endpoints

  • Authentication
    • Log in user by creating and registering auth tokens. POST
    • Log user out by revoking his auth tokens. GET
    • Returns information if the user is authenticated else it returns a 401 GET
    • Allow a user to register himself to the service. POST
    • Allow the user to change his password. POST
    • Resource to allow a user to change his password when he forgets it. PUT
    • Resource to allow a user to change his password when he forgets it. POST
    • Tokens are considered as outdated every two weeks. GET
    • Resource to allow a user to pre-enable TOTP. PUT
    • Resource to allow a user to enable TOTP. POST
    • Resource to allow a user to disable TOTP. DELETE
    • Resource to send an OTP by email to user. GET
    • Resource to allow a user to pre-enable OTP by email. PUT
    • Resource to allow a user to enable OTP by email. POST
    • Resource to allow a user to disable OTP by email. DELETE
    • Resource to allow a user to generate new recovery codes. PUT
    • Resource to get a challenge for a FIDO device. GET
    • Resource to allow a user to pre-register a FIDO device. PUT
    • Resource to allow a user to register a FIDO device. POST
    • Resource to allow a user to unregister a FIDO device. DELETE
    • Resource to allow a user to login with SAML SSO. POST
    • Resource to allow a user to login with SAML SSO. GET
  • Assets
    • Retrieve all asset types (entity types that are not shot, sequence or episode). GET
    • Retrieve given asset type. GET
    • Retrieve all entities that are not shot or sequence. GET
    • Retrieve all entities that are not shot or sequence. GET
    • Retrieve all entities that are not shot or sequence. GET
    • Retrieve given asset. GET
    • Delete given asset. DELETE
    • Retrieve all assets for a given asset. GET
    • Retrieve all tasks related to a given shot. GET
    • Retrieve all task types related to a given asset. GET
    • Resource to retrieve the casting of a given asset. GET
    • Resource to retrieve the casting of a given asset. GET
    • Resource to allow the modification of assets linked to a asset. PUT
    • Retrieve all shot asset instances linked to asset. GET
    • Retrieve all scene asset instances linked to asset. GET
    • Retrieve all asset instances instantiated inside this asset. GET
    • Create an asset instance inside given asset. POST
    • Retrieve all assets for given project and entity type. GET
    • Create new asset resource. POST
    • Retrieve all asset types for given project. GET
    • Retrieve all asset shots for given shot. GET
    • Retrieve all assets for given project. GET
    • Share or unshare a list of assets. POST
    • Share or unshare all assets (or a list of assets) for given project. POST
    • Share or unshare all assets for given project and asset type. POST
    • Retrieve all shared assets used in project. GET
    • Retrieve all shared assets used in project episode. GET
  • Breakdown
    • Resource to retrieve the casting of a given entity. GET
    • Resource to allow the modification of assets linked to an entity. PUT
    • Resource to retrieve the casting of assets from given asset type. GET
    • Resource to retrieve the casting of episodes. GET
    • Resource to retrieve the casting of shots from given sequence. GET
    • Resource to retrieve the casting of shots from given episode. GET
    • Resource to retrieve the casting of shots from all sequences of given GET
    • Retrieve all entity links related to given project. GET
    • Delete given entity link. DELETE
    • Retrieve all asset instances linked to scene. GET
    • Create an asset instance on given scene. POST
    • Retrieve all camera instances linked to scene. GET
    • Retrieve all asset instances linked to shot. GET
    • Add an asset instance to given shot. POST
    • Remove an asset instance from given shot. DELETE
  • Comments
    • Acknowledge given comment. POST
    • Reply to given comment. POST
    • Delete attachment linked to a comment matching given ID. DELETE
    • Delete given comment reply. DELETE
    • Download attachment file. GET
    • Add given files to the comment entry as attachments. POST
    • Return all attachment files related to given project. GET
    • Return all attachment files related to given task. GET
    • Create a new comment for given task. POST
    • Create several comments at once. POST
    • Creates new comments for given task. Each comments requires a text, a POST
    • Creates new comments for given task. Each comments requires a task_id, POST
  • Crud
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a software corresponding at given ID and return it as a GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve an output type corresponding at given ID and return it as a GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a preview file corresponding at given ID and retuns DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a working file corresponding at given ID and return it as a GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
    • Retrieve all entries for given model. GET
    • Create a model with data given in the request body. POST
    • Retrieve a model corresponding at given ID and return it as a JSON object. GET
    • Update a model with data given in the request body. PUT
    • Delete a model corresponding at given ID and return it as a JSON object. DELETE
  • Edits
    • Retrieve all edit entries. GET
    • Retrieve all edit entries. GET
    • Retrieve all edits, adds project name and all related tasks. GET
    • Retrieve given edit. GET
    • Delete given edit. DELETE
    • Retrieve all task types related to a given edit. GET
    • Retrieve all tasks related to a given edit. GET
    • Retrieve all previews related to a given edit. GET
    • Retrieve data versions of given edit. GET
    • Retrieve all edits related to a given episode. GET
    • Retrieve all tasks related to a given episode. GET
    • Retrieve all edits related to a given project. GET
    • Create an edit for given project. POST
  • Entities
    • Retrieve all news linked to a given entity. GET
    • Retrieve all preview files linked to a given entity. GET
    • Retrieve all time spents linked to a given entity. GET
  • Events
    • Retrieve last events. GET
    • Retrieve all login logs. GET
  • Export
    • Export assets linked to a given project as csv. GET
    • Export shots linked to a given project as csv. GET
    • Export casting linked to a given project as csv. GET
    • Export edits linked to a given project as csv. GET
    • Export a given playlist as csv. GET
    • Export as csv. GET
    • Export as csv. GET
    • Export as csv. GET
    • Export as csv. GET
    • Export as csv. GET
  • Files
    • Get information about a file that could be a working file as much as an GET
    • Return last working files revision for each file name for given task. GET
    • Create new working file. POST
    • Return last working files revision for each file name for given task. GET
    • Generate a working file path from file tree template. POST
    • Create new output file linked to assets through an instance of this asset for a given shot. POST
    • Get next revision for given asset instance, output type, task type and name. POST
    • Get last revisions of output files for given instance grouped by output type and file name. GET
    • Return all types of output generated for given instance. GET
    • Get all output files for given asset instance and given output type. GET
    • Generate an output file path from file tree template POST
    • Get all working files for a given entity and possibly a task and a name. GET
    • Create new output file linked to a given entity. POST
    • Get next revision for given entity, output type, task type and name. POST
    • Get last revisions of output files for given entity grouped by output type and file name. GET
    • Return all types of output generated for given entity. GET
    • Get all output files for given entity and given output type. GET
    • Get all output files for given entity. GET
    • Get all output files for given poject. GET
    • Get all output files for given asset instance and given output type. GET
    • Generate an output file path from file tree template POST
    • Download a working file. GET
    • Store a working file. POST
    • Define a template file to use for given project. POST
    • Update comment on given working file. PUT
    • Update working file modification date with current date. PUT
  • Import
    • Import shotgun resource. POST
    • Import shotgun resource. POST
    • Import shotgun resource. POST
    • Import shotgun resource. POST
    • Import shotgun resource. POST
    • Import shotgun resource. POST
    • Import shotgun resource. POST
    • Import shotgun resource. POST
    • Import shotgun resource. POST
    • Import shotgun resource. POST
    • Import shotgun resource. POST
    • Import shotgun resource. POST
    • Import shotgun error resource. GET
    • Serialize shotgun error resource. POST
    • Import shotgun resource. POST
    • Delete error. DELETE
    • Import remove instance. POST
    • Import remove instance. POST
    • Import remove instance. POST
    • Import remove instance. POST
    • Import remove instance. POST
    • Import remove instance. POST
    • Import remove instance. POST
    • Import remove instance. POST
    • Import remove instance. POST
    • Import remove instance. POST
    • Import remove instance. POST
    • Import remove instance. POST
    • Import remove instance. POST
    • Import persons via a .csv file. POST
    • Import project assets via a .csv file. POST
    • Import project shots via a .csv file. POST
    • Import project edits. POST
    • Import project casting links via a .csv file. POST
    • Import the estimations of task-types for given project. POST
    • Import the estimations of task-types for given episode of given project. POST
    • Import an OTIO file to enter frame_in / frame_out / nb_frames (it can POST
    • Import an OTIO file to enter frame_in / frame_out / nb_frames (it can POST
    • Import Kitsu resource. POST
    • Import Kitsu resource. POST
    • Import Kitsu resource. POST
    • Import Kitsu resource. POST
    • Import Kitsu resource. POST
  • Index
    • Get API name and version. GET
    • Retrieve API name, version and status. GET
    • Retrieve status of database and time. GET
    • Retrieve date and CPU, memory and jobs stats. GET
    • Retrieve API name, version and status as txt. GET
    • Generate a main:test event. GET
    • Retrieve main stats. GET
    • Get basic configuration for the current instance. GET
  • News
    • Retrieve all news related to a given project GET
    • Retrieve all news related to a given project GET
    • Retrieve a single given news related to a given project GET
  • Persons
    • Retrieve desktop login logs. GET
    • Create desktop login logs. POST
    • Return a csv file containing the presence logs based on a daily basis. GET
    • Get time spents for given person and date. GET
    • Get day off object for given person and date. GET
    • Get aggregated time spents for given person and year. GET
    • Get aggregated time spents for given person and month. GET
    • Get aggregated time spents for given person and week. GET
    • Get aggregated time spents for given person and day. GET
    • Get ended shots used for quota calculation of this month. GET
    • Get ended shots used for quota calculation of this week. GET
    • Get ended shots used for quota calculation of this day. GET
    • Return a table giving time spent by user and by month for given year. GET
    • Return a table giving time spent by user and by month for given year. GET
    • Return a table giving time spent by user and by week for given year. GET
    • Return a table giving time spent by user and by day for given year and month. GET
    • Return all day off recorded for given month. GET
    • Return all day off recorded for given week and person. GET
    • Return all day off recorded for given month and person. GET
    • Return all day off recorded for given year and person. GET
    • Return all day offs recorded for given and person. GET
    • Sends an email to given person to invite him/her to connect to Kitsu. GET
    • Add a user to given department. POST
    • Remove a user from given department. DELETE
    • Allow admin to change password for given user. POST
    • Allow admin to disable two factor authentication for given user. DELETE
  • Playlists
    • Retrieve all playlists related to given project. GET
    • Retrieve all playlists related to given project. GET
    • Retrieve all playlists related to given episode. GET
    • Retrieve all playlists related to given project. GET
    • Retrieve all previews related to a given entity. GET
    • Retrieve build job related to given playlist. GET
    • Remove given build job related to given playlist. DELETE
    • Retrieve all build jobs related to given project. GET
    • Build given playlist as mp4 movie. GET
    • Download given playlist build as .mp4. GET
    • Download given playlist as zip. GET
    • Retrieve all playlists related to given project. POST
  • Previews
    • Retrieve all preview files from open productions with states equals to processing or broken. GET
    • Main resource to add a preview. POST
    • Download a movie preview. GET
    • Download a movie preview. GET
    • Download a lowdef movie preview. GET
    • Download a thumbnail. GET
    • Download the thumbnail representing given attachment file. GET
    • Download a thumbnail. GET
    • Download a thumbnail. GET
    • Download a generic file preview. GET
    • Download a generic file preview as attachment. GET
    • Download a thumbnail. GET
    • Download a thumbnail. GET
    • Download the thumbnail linked to given object instance. GET
    • Create a thumbnail for given object instance. POST
    • Download the thumbnail linked to given object instance. GET
    • Create a thumbnail for given object instance. POST
    • Download the thumbnail linked to given object instance. GET
    • Create a thumbnail for given object instance. POST
    • Download the thumbnail linked to given object instance. GET
    • Create a thumbnail for given object instance. POST
    • Download the thumbnail linked to given object instance. GET
    • Create a thumbnail for given object instance. POST
    • Download the thumbnail linked to given object instance. GET
    • Create a thumbnail for given object instance. POST
    • Download the thumbnail linked to given object instance. GET
    • Create a thumbnail for given object instance. POST
    • Download a preview background file. GET
    • Set given preview as main preview of the related entity. PUT
    • Extract a frame from a preview_file GET
    • Allow to change orders of previews for a single revision. PUT
    • Allow to modify the annotations stored at the preview level. PUT
  • Projects
    • Return the list of projects currently running. GET
    • Return all projects listed in database. GET
    • Return the people listed in a production team. GET
    • Add a person to a production team. POST
    • Retrieve task types linked to the production GET
    • Remove people listed in a production team. DELETE
    • Add an asset type linked to a production. POST
    • Remove an asset type from a production. DELETE
    • Add a task type linked to a production. POST
    • Remove a task type from a production. DELETE
    • Return task statuses linked to a production GET
    • Add a task type linked to a production. POST
    • Remove a task status from a production. DELETE
    • Get a status automation linked to a production. GET
    • Add a status automation linked to a production. POST
    • Remove a status automation from a production. DELETE
    • Remove a preview background file from a production. DELETE
    • Return preview background files linked to a production GET
    • Add a preview background file linked to a production. POST
    • Get all metadata descriptors GET
    • Create a new metadata descriptor POST
    • Get a metadata descriptor. GET
    • Update a metadata descriptor. PUT
    • Delete a metadata descriptor. DELETE
    • Retrieve milestones for given production GET
    • Retrieve schedule items for given production GET
    • Retrieve task type schedule items for given production GET
    • Retrieve asset types schedule items for given task type GET
    • Retrieve episodes schedule items for given task type GET
    • Retrieve sequences schedule items for given task type GET
    • Retrieve time spents for given production GET
  • Search
    • Search for resource POST
  • Shots
    • Retrieve all shot entries. GET
    • Retrieve all shot entries. GET
    • Retrieve all shots, adds project name and asset type name and all related tasks. GET
    • Retrieve given shot. GET
    • Update given shot. PUT
    • Delete given shot. DELETE
    • Retrieve all assets for a given shot. GET
    • Retrieve all task types related to a given shot. GET
    • Retrieve all tasks related to a given shot. GET
    • Retrieve all previews related to a given shot. GET
    • Retrieve data versions of given shot. GET
    • Retrieve all scene entries. GET
    • Retrieve all scenes, adds project name and asset type name and all related tasks. GET
    • Retrieve given scene. GET
    • Delete given scene. DELETE
    • Retrieve all tasks related to a given scene. GET
    • Retrieve all task types related to a given scene. GET
    • Retrieve all shots that come from given scene. GET
    • Mark given scene as source of given shot. POST
    • Delete given shot from given scene. DELETE
    • Retrieve all episode entries. GET
    • Retrieve all episodes, adds project name and asset type name and all related tasks. GET
    • Retrieve given episode. GET
    • Delete given episode. DELETE
    • Retrieve all shots related to a given episode. GET
    • Retrieve all sequence entries for a given episode. GET
    • Retrieve all tasks related to a given episode. GET
    • Retrieve all task types related to a given episode. GET
    • Retrieve all shots tasks related to a given episode. GET
    • Retrieve all assets tasks related to a given episode. GET
    • Retrieve all sequence entries. GET
    • Retrieve all sequences, adds project name and asset type name and all related tasks. GET
    • Retrieve given sequence. GET
    • Delete given sequence. DELETE
    • Retrieve all shot entries for a given sequence. GET
    • Retrieve all scenes related to a given sequence. GET
    • Retrieve all tasks related to a given shot. GET
    • Retrieve all task types related to a given shot. GET
    • Retrieve all tasks related to a given sequence. GET
    • Retrieve all shots related to a given project. GET
    • Create a shot for given project. POST
    • Retrieve all scenes related to a given project. GET
    • Create a scene for given project. POST
    • Retrieve all sequences related to a given project. GET
    • Create a sequence for given project. POST
    • Retrieve all episodes related to a given project. GET
    • Create an episode for given project. POST
    • Retrieve number of tasks by status, task_types and episodes for given project. GET
    • Retrieve number of tasks by status, task_types and episodes for given project. GET
    • Retrieve quotas statistics for shots. GET
    • Set frames for given shots. POST
  • Tasks
    • Return all tasks related to open projects. GET
    • Return task amount, task done amount, total estimation, total duration GET
    • Return comments linked to given task. GET
    • Get comment corresponding at given ID. GET
    • Delete a comment corresponding at given ID. DELETE
    • Return previews linked to given task. GET
    • Return a task with many information. GET
    • Return task assigned to given user of which status has is_done flag sets to false. GET
    • For all entities assigned to given person (that have at least one task assigned to given person), returns all tasks for given task type. GET
    • Return task assigned to given user of which status has is_done flag sets to true. GET
    • Return tasks related to given entity asset, episode, sequence, shot or scene. GET
    • Retrieve all comments to tasks related to given project. GET
    • Retrieve all notifications to tasks related to given project. GET
    • Preview files related to a given project. GET
    • Retrieve all subcriptions to tasks related to given project. GET
    • Retrieve all tasks related to given project. GET
    • For schedule usages, for each active person, it returns the first start GET
    • Delete all tasks for a given task type and project. DELETE
    • Delete tasks matching id list given in parameter. POST
    • Assign given task list to given person. PUT
    • Remove all assignations set to given task. PUT
    • Assign given task lists to given person. PUT
    • Get time spent on a given task and date. GET
    • Get time spent on a given task. GET
    • Set time spent by a person on a task for a given day. POST
    • Delete time spent by a person on a task for a given day. DELETE
    • Add given timeframe to time spent by a person on a task for a given day. POST
    • Add preview metadata to given task. The preview file itself should be POST
    • Add a preview to given comment. POST
    • Delete preview from given comment. DELETE
    • Change a task status to "to review". PUT
    • Create a new task for given shot and task type. POST
    • Create a new task for given asset and task type. POST
    • Create a new task for given edit and task type. POST
    • Create a new task for given concept and task type. POST
    • Create a new task with given task type for each entity of given POST
  • User
    • Set `has_avatar` flag to False for current user and remove its avatar DELETE
    • Return context required to properly run a full app connected to the API GET
    • Return tasks related to given asset for current user. GET
    • Return tasks related to given shot for current user. GET
    • Return tasks related to given scene for current user. GET
    • Return tasks related to given sequence for current user. GET
    • Return task types related to given asset for current user. GET
    • Return tasks related to given shot for current user. GET
    • Return tasks related to given scene for current user. GET
    • Return tasks related to given sequence for current user. GET
    • Return open projects for which the user has at least one task assigned. GET
    • Return asset types related to given project if the current user has GET
    • Return assets of which type is given asset type and are listed in given GET
    • Return sequences related to given project if the current user has access GET
    • Return episodes related to given project if the current user has access GET
    • Return shots related to given sequence if the current user has access GET
    • Return scenes related to given sequence if the current user has access GET
    • Return tasks currently assigned to current user and of which status has GET
    • Return tasks requiring feedback for current user departments. GET
    • Return tasks currently assigned to current user and of which status has GET
    • Retrieve filters for current user and only for open projects. GET
    • Create filter for current user and only for open projects. POST
    • Update given filter if it's owned by current user. PUT
    • Delete given filter if it's owned by current user. DELETE
    • Retrieve filter groups for current user and only for open projects. GET
    • Create filter group for current user and only for open projects. POST
    • Retrieve given filter group for the current user. GET
    • Update given filter group if it's owned by the current user. PUT
    • Delete given filter group if it's owned by the current user. DELETE
    • Retrieve desktop login logs. GET
    • Create a desktop login log. POST
    • Get time spents for current user and given date. GET
    • Get day off object for current user and given date. GET
    • Return last 100 user notifications filtered by given parameters. GET
    • Return notification matching given id, only if it's a notification that GET
    • Change notification read status. PUT
    • Return true if current user has subscribed to given task. GET
    • Return chats where user is participant. GET
    • Join chat for given entity (be listed as participant). POST
    • Leave chat for given entity (be removed from participants). DELETE
    • Create a subscription entry for given task and current user. POST
    • Remove the subscription entry matching given task and current user. DELETE
    • Set `has_avatar` flag to False for current user and remove its avatar DELETE
    • Return true if current user has subscribed to given sequence and GET
    • Return the list of sequence ids to which the current user has GET
    • Create a subscription entry for given sequence, POST
    • Remove a subscription entry for given sequence, tasl type DELETE
    • Mark all notifications as read for the current user. POST
  • Chat
    • Get chat details. GET
    • Get chat messages for an entity. GET
    • Create a new chat message. POST
    • Get chat message. GET
    • Delete chat message. DELETE
  • Entity
    • Resource to retrieve the entities linked on a given entity. GET
  • Task
    • Set last preview from given task as main preview of the related entity. PUT
  • Preview background file
    • Main resource to add a preview background file. POST
  • Concepts
    • Retrieve all concept entries. GET
    • Retrieve all concepts, adds project name and asset type name and all related tasks. GET
    • Retrieve given concept. GET
    • Delete given concept. DELETE
    • Retrieve all task types related to a given concept. GET
    • Retrieve all tasks related to a given concept. GET
    • Retrieve all previews related to a given concept. GET
    • Retrieve all concepts related to a given project. GET
    • Create a concept for given project. POST
Powered by Bump.sh