Skip to main content
GET
/
v1
/
layouts
/
{id}
Get layout by ID
curl --request GET \
  --url https://api.oneofnone.io/v1/layouts/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "grid_config": {
    "columns": 123,
    "templateColumns": [
      "<string>"
    ],
    "templateRows": [
      "<string>"
    ],
    "gap": "<string>",
    "padding": "<string>",
    "maxContentWidth": "<string>",
    "areas": [
      {
        "id": "<string>",
        "name": "<string>",
        "startRow": 123,
        "endRow": 123,
        "startCol": 123,
        "endCol": 123,
        "isLocked": true
      }
    ]
  },
  "components": [
    {
      "id": "<string>",
      "type": "<string>",
      "areaId": "<string>",
      "order": 123,
      "title": "<string>",
      "description": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "blocks": [
    {}
  ],
  "colors": {},
  "typography": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

The API key required for accessing protected routes. It should be included in the request headers as x-api-key.

Path Parameters

​
id
string<uuid>
required

The UUID of the layout to retrieve.

Response

Layout retrieved successfully.

A layout defines the visual structure and components for a collection page.

​
id
string<uuid>

Unique identifier for the layout.

​
name
string | null

Display name of the layout.

​
grid_config
object

CSS Grid configuration for the layout.

​
components
object[] | null

Layout components.

​
blocks
object[] | null

Layout blocks with content and styling.

​
colors
object

Color theme overrides.

​
typography
object

Typography overrides.

​
created_at
string<date-time>
​
updated_at
string<date-time> | null