LogoDocumentation

Layouts

layouts

Methods

List Layouts -> Array<{ id, createdAt, name, 5 more... }>
get/layouts

List the org layouts.

Note: Only layouts shared with the org are returned in the response; no personal layouts are returned.

query Parameters
includeData: boolean
Optional
(default: true)

When set to false, the data field is omitted from the response items. This can be used to limit bandwidth when querying many Layouts.

updatedSince: string
Optional
(format: date-time)

Return only layouts updated since this time.

Response fields
id: string

ID of the layout

createdAt: string
(format: date-time)

Timestamp when the layout was created on the server

name: string

Name of the layout

permission: "CREATOR_WRITE" | "ORG_READ" | "ORG_WRITE"
updatedAt: string
(format: date-time)

Timestamp when the layout was last updated on the server

data: Record<string, unknown>
Optional

An object containing the layout data.

Note: The layout data format is not considered stable and may change over time.

folderName: string
Optional

Name of the folder the layout belongs to.

savedAt: string
Optional
(format: date-time)

Timestamp when the layout was last saved locally

Request example
200Example