🔒
Requires write_themes access scope. More access scope

The Get Theme Doctree API retrieves the structural details of a theme, including its layouts, templates, sections, snippets, assets, configuration files, and locales. This allows developers to analyze the theme's structure and contents programmatically.

This API is especially useful for:

Inspecting the files and assets of a theme.
Managing or modifying theme components programmatically.
Analyzing the organization of the theme for customization or debugging.

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Path Parameters

Parameter	Type	Required	Example	Description
`theme_id`	string	Yes	`1500021b-88ed-4750-bbc5-97ec98351dc0`	Theme's unique identifier.

Response Explanation

Public Response Parameters

📘
Public Response Parameters

Successful Response

Parameter	Type	Example	Description
`code`	`string`	`"success"`	Status code of the response
`message`	`string`	`"OK"`	Descriptive message of the response
`data.layouts`	`array[object]`	`[{...}]`	Array of layout files
`data.templates`	`array[object]`	`[{...}]`	Array of template files
`data.sections`	`array[object]`	`[{...}]`	Array of section files
`data.snippets`	`array[object]`	`[{...}]`	Array of snippet files
`data.assets`	`array[object]`	`[{...}]`	Array of asset files
`data.configs`	`array[object]`	`[{...}]`	Array of configuration files
`data.locales`	`array[object]`	`[{...}]`	Array of localization files

File Object Structure (applies to all arrays)

Parameter	Type	Example	Description
`id`	`string`	`"file_123"`	Unique identifier for the file
`location`	`string`	`"templates/product.liquid"`	Relative path to the file in the theme

Error Response

Field	Type	Example	Description
`code`	string	`InvalidParameter`	Error http message
`message`	string	``	Error message

API Structure Overview

200OK