Clarify APILayouts
Get a layout
Returns a single layout by its ID. A layout defines the UI structure — navigation, record page regions — rendered for the workspace.
Authorization
apiKey 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.
Response Body
application/json
curl -X GET "https://example.com/workspaces/string/layouts/string"{
"_id": "list__person",
"tree": {
"version": 1,
"children": [
{
"id": "views",
"type": "NavGroup",
"props": {
"name": "Views"
},
"children": [
{
"id": "all-people",
"type": "NavLink",
"props": {
"entity": "person"
}
}
]
}
]
},
"_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"
}