Skip to content
Tilecast Docs

listLayouts

GET
/api/v1/layouts
curl --request GET \
  --url https://example.com/api/v1/layouts \
  --cookie tilecast_session=<tilecast_session>

Requires an authenticated dashboard session. Layout summaries include hasUnpublishedChanges, computed by comparing the current draft document with the published document rather than by comparing their independent revision counters.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
search
string
page
integer
>= 1
pageSize
integer
>= 1 <= 100

Responses

Section titled “ Responses ”

200

Section titled “200”

Paginated Layout summaries

Media typeapplication/json
object
data
required
object
items
required
Array<object>

Compact Layout row returned by the Layout list. The editable draft, dependency list, and usage breakdown require the detail read.

object
id
required
string format: uuid
name
required
string
description
required
string
orientation
required
string
Allowed values: landscape portrait custom
canvasWidth
required
integer
>= 320 <= 7680
canvasHeight
required
integer
>= 320 <= 7680
draftRevision
required
integer format: int64
publishedRevisionId
string format: uuid
publishedRevision
integer format: int64
publishedAt
string format: date-time
hasUnpublishedChanges
required
boolean
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
previewImageUrl
string
previewCaptureVersion
integer
>= 1
total
required
integer
page
required
integer
>= 1
pageSize
required
integer
>= 1
Example
{
  "data": {
    "items": [
      {
        "orientation": "landscape"
      }
    ]
  }
}

401

Section titled “401”

Dashboard authentication required