Skip to content

Notes & Playlists ​

Manage notes and playlists in ShotGrid.

Notes ​

shotgrid.note.create ​

Create a new note on an entity.

Parameters ​

ParameterTypeRequiredDescription
project_idnumberYesProject ID
entity_typestringYesLinked entity type
entity_idnumberYesLinked entity ID
subjectstringNoNote subject
contentstringYesNote content
addressings_toarrayNoUsers to notify

Example ​

Add a note to shot 456 saying "Animation approved, ready for lighting"

shotgrid.note.read ​

Read a note's content.

Parameters ​

ParameterTypeRequiredDescription
note_idnumberYesNote ID

Example ​

Read note 789

shotgrid.note.update ​

Update an existing note.

Parameters ​

ParameterTypeRequiredDescription
note_idnumberYesNote ID
contentstringNoNew content
subjectstringNoNew subject

Example ​

Update note 789 with new content

Playlists ​

create_playlist ​

Create a new playlist for review.

Parameters ​

ParameterTypeRequiredDescription
project_idnumberYesProject ID
codestringYesPlaylist name
versionsarrayNoVersion IDs to include

Example ​

Create a playlist called "Daily Review" with versions 100, 101, 102

find_playlists ​

Find playlists matching criteria.

Parameters ​

ParameterTypeRequiredDescription
project_idnumberNoFilter by project
filtersarrayNoAdditional filters

Example ​

Find all playlists in project 123

Released under the MIT License.