Skip to content
VIDMOATDocs

List projects

GEThttps://api.vidmoat.com/v1/projects
Bearer tokenScope projects.readFreeTry it in the playground

List your projects, most recently updated first. Add ?workspace=<id> to list one folder, or ?workspace=unfiled for the ones in none.

Query parameters#

  • limitintegerdefault 20
    Page size, up to 100.
  • cursorstring
    The nextCursor of the previous page.
  • viewenumdefault summary
    How much of each project to return. document is only available on a single project; asking for it here returns clips with a note.
    One of summary, clips
  • workspacestring
    A workspace id, or unfiled.

Response#

Returns 200.

Response fields#

  • dataarray
    Projects, in the requested view.
    Show 11 child fields
    • idstring
      Project id.
    • namestring
      Project name.
    • createdAtstring
      ISO 8601 time.
    • updatedAtstring
      ISO 8601 time.
    • durationSecnumber
      End of the last clip, in seconds.
    • clipCountinteger
      Number of clips on the timeline.
    • settingsobject
      Output settings.
      Show 5 child fields
      • aspectRatiostring
        For example 16:9.
      • widthinteger
        Pixels.
      • heightinteger
        Pixels.
      • fpsnumber
        Frames per second.
      • backgroundstring
        CSS colour.
    • workspaceobject or null
      The workspace it is filed in: { id, name }, or null.
    • tracksarray
      Only in the clips and document views. The timeline tracks.
    • clipsarray
      Only in the clips view: a summary per clip (id, type, name, start, duration, trackIndex, and src, text, effects, speed, keyframedProps when set).
    • documentobject
      Only in the document view: the full edit document, verbatim.
  • hasMoreboolean
    Whether another page exists.
  • nextCursorstring or null
    Pass as cursor for the next page.