Skip to navigation
RESTAdminContentCustom Template Associations

List Custom Template Associations

Get a collection of the storeʼs custom template associations across all storefronts.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI NamePermissionParameter
ThemesRead-onlystore_themes_read_only
ThemesManagestore_themes_manage

Authentication header

HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

Further reading

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

Path parameters

store_hashstringRequired
Permanent ID of the BigCommerce store.

Headers

AcceptstringRequiredDefaults to application/json

The MIME type of the response body.

Query parameters

channel_idintegerOptional
Return results or act upon only template associations in the specified channel.
entity_id:inlist of integersOptional

A comma-separated list of entity IDs to return or act upon. Must be used together with the type filter. Currently, all supported entities have integer-type IDs.

typeenumOptional
Filter associations by type.
Allowed values:
limitintegerOptional
Number of results to return per page.
pageintegerOptional
Which page number to return, based on the limit value. Used to paginate large collections.
is_validbooleanOptional
Optional toggle to filter for exclusively valid or invalid associations entries. An invalid entry is one where its file name does not match up to an existing custom layout file in the currently active theme for the channel.

Response

OK
datalist of objectsOptional
metaobjectOptional