Layouts

Operations

List layouts

Request

List the org layouts.

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

Security

ApiKey(Required scopes: layouts.list)

Query

updatedSincestring, (date-time)

Return only layouts updated since this time.

includeDataboolean

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

Default:true

Payload

// No request payload

Responses

List of org layouts

Bodyapplication/json

Array [

idstringrequired

ID of the layout

namestringrequired

Name of the layout

createdAtstring, (date-time)required

Timestamp when the layout was created on the server

updatedAtstring, (date-time)required

Timestamp when the layout was last updated on the server

savedAtstring, (date-time)

Timestamp when the layout was last saved locally

folderNamestring

Name of the folder the layout belongs to.

permissionstring(LayoutPermission)required

Enum:"CREATOR_WRITE""ORG_READ""ORG_WRITE"

dataobject

Layout contents. The format may change. Treat it as opaque and preserve values returned by the API.

]

Response

[
  {
    "id": "string",
    "name": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "savedAt": "2019-08-24T14:15:22Z",
    "folderName": "string",
    "permission": "CREATOR_WRITE",
    "data": {}
  }
]