Skip to content

Get a site

GEThttps://api.vidmoat.com/v1/interactive-sites/{id}
Bearer tokenScope projects.readFreeTry it in the playground

The site: its draft design, a digest of every page and section with its id, problems, status and a preview link of the draft on its real address.

Path parameters#

  • idstringrequired
    The site id.

Query parameters#

  • videosboolean
    true also lists the videos the site may show: the account's interactive exports whose choices are published and shared.
  • imagesboolean
    true also lists library pictures for a logo or an about section.

Response#

Returns 200.

Response fields#

  • siteobject
    id, prefix, url, status, rev, shown, notShownBecause, takenDown, previewUrl, design, digest, problems, unpublishedChanges, and videos / images when asked.

Errors#

Besides the errors any request can get (authentication, rate limits):

StatusCodeWhen
404not_foundNo such project, or it is not yours. The two are indistinguishable on purpose.