Layouts
Get a layout
Returns a single layout by its ID. A layout defines the UI structure - navigation, record page regions - rendered for the workspace. An unknown list entity in the layout returns 404.
Authorization<token>
API key authentication. Send your key in the Authorization header as: api-key <your-api-key>.
In: header
Path Parameters
workspace*string
The workspace slug — the {slug} segment of your Clarify workspace URL.
id*string
The unique ID of the layout. A record page layout is record-page__{entity}, for example record-page__deal.
Header Parameters
clarify-version?string
The API version for this request. Send 2026-10 to get the behavior documented here. Omit it to use your API key's version, which this header can raise but not lower.
Response Body
application/json
curl -X GET "https://example.com/workspaces/string/layouts/string" \ -H "clarify-version: 2026-10"{ "_id": "list__deal", "tree": { "version": 1, "children": [ { "id": "views", "type": "NavGroup", "props": { "name": "Views" }, "children": [ { "id": "all-deals", "type": "NavLink", "props": { "entity": "deal", "listId": "9d2c4e6f-8a1b-4c3d-9e5f-7a9b1c3d5e7f" } } ] } ] }, "_created_by": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81", "_updated_by": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81", "_created_at": "2026-01-15T09:30:00.000Z", "_updated_at": "2026-02-01T17:45:00.000Z"}