Login is based on email and password. If no user match given email and a destkop ID, it looks in matching the desktop ID with the one stored in database. It is useful for clients that run on desktop tools and that don't know user email.
curl \
--request POST 'http://api.example.com/auth/login' \
--header "Authorization: $API_KEY"This route allows to make their lifetime long before they get outdated.
curl \
--request GET 'http://api.example.com/auth/refresh-token' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/auth/email-otp' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/auth/email-otp' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/asset-types' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/asset-types/{asset_type_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/assets/{asset_id}/casting' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/shots/{shot_id}/asset-types' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/scenes/{scene_id}/asset-instances' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/data/scenes/{scene_id}/asset-instances' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/attachment-files/{attachment_file_id}/file/{file_name}' \
--header "Authorization: $API_KEY"task_status and a person as arguments.
curl \
--request POST 'http://api.example.com/actions/tasks/{task_id}/batch-comment' \
--header "Authorization: $API_KEY"JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/projects' \
--header "Authorization: $API_KEY"JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/entity-types' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/entity-types/{instance_id}' \
--header "Authorization: $API_KEY"Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/entities' \
--header "Authorization: $API_KEY"JSON format is expected. Model performs the validation automatically when fields are modified.
curl \
--request PUT 'http://api.example.com/data/task-status/{instance_id}' \
--header "Authorization: $API_KEY"Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/file-status/' \
--header "Authorization: $API_KEY"JSON object.
curl \
--request GET 'http://api.example.com/data/softwares/{instance_id}' \
--header "Authorization: $API_KEY"Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/output-types' \
--header "Authorization: $API_KEY"JSON format is expected. Model performs the validation automatically when fields are modified.
curl \
--request PUT 'http://api.example.com/data/preview-files/{instance_id}' \
--header "Authorization: $API_KEY"Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/time-spents/' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/day-offs/{instance_id}' \
--header "Authorization: $API_KEY"Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/asset-instances/' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/playlists/{instance_id}' \
--header "Authorization: $API_KEY"Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/events/' \
--header "Authorization: $API_KEY"JSON format is expected. Model performs the validation automatically when fields are modified.
curl \
--request PUT 'http://api.example.com/data/events/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/search-filter-groups/{instance_id}' \
--header "Authorization: $API_KEY"JSON format is expected. Model performs the validation automatically when fields are modified.
curl \
--request PUT 'http://api.example.com/data/milestones/{instance_id}' \
--header "Authorization: $API_KEY"Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/metadata-descriptors/' \
--header "Authorization: $API_KEY"Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/subscriptions/' \
--header "Authorization: $API_KEY"JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/subscriptions/' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/subscriptions/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/chats/{instance_id}' \
--header "Authorization: $API_KEY"JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/studios' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/salary-scales/{instance_id}' \
--header "Authorization: $API_KEY"JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/plugins' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/edits/{edit_id}/tasks' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/entities/{entity_id}/time-spents' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/export/csv/projects/{project_id}/edits.csv' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/export/csv/projects.csv' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/export/csv/time-spents.csv' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/next-revision' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/projects/{project_id}/output-files' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/asset-instances/{asset_instance_id}/output-files' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/shotgun/scenes' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/shotgun/assets' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/shotgun/tasks' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/import/shotgun/errors' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/import/shotgun/errors/{error_id}' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/shotgun/remove/project' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/shotgun/remove/status' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/shotgun/remove/task' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/csv/projects/{project_id}/episodes/{episode_id}/task-types/{task_type_id}/estimations' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/config' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/persons/{person_id}/time-spents/{date}' \
--header "Authorization: $API_KEY"Prior to disable two factor authentication, it requires to be admin. An admin can't disable two factor authentication for other admins.
curl \
--request DELETE 'http://api.example.com/actions/persons/{person_id}/disable-two-factor-authentication' \
--header "Authorization: $API_KEY"Result is paginated and can be sorted.
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/playlists' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/playlists/{playlist_id}/jobs/{build_job_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/playlists/{playlist_id}/download/zip' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/pictures/thumbnails/attachment-files/{attachment_file_id}.png' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/projects/{project_id}/settings/status-automations' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/data/projects/{project_id}/settings/status-automations' \
--header "Authorization: $API_KEY"It serves to describe extra fields listed in the data attribute of entities.
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/metadata-descriptors' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/projects/{project_id}/schedule-items/{task_type_id}/episodes' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/shots/with-tasks' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/shots/{shot_id}/versions' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/scenes/{scene_id}/shots/{shot_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/episodes/{episode_id}/task-types' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/sequences' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/sequences/with-tasks' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/sequences/{sequence_id}/scenes' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/data/projects/{project_id}/sequences' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/projects/{project_id}/episodes' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/persons/{person_id}/related-tasks/{task_type_id}' \
--header "Authorization: $API_KEY"It's mainly used for synchronisation purpose.
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/notifications' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/actions/tasks/{task_id}/time-spents/{date}/persons/{person_id}/add' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/task-types/{task_type_id}/assets/create-tasks' \
--header "Authorization: $API_KEY"