Branding
Themes and confirmed brand (read-only design truth).
Authorization
apiKey A Formtoro API key minted in Settings → Connections. A key carries one
or more scopes; an endpoint refuses a key that lacks its required scope
with 403 insufficient_scope. Scopes:
analytics:read— all aggregate read endpoints.customers:read— customer-level lifetime value.forms:write— create and edit forms (drafts). Grantable only by a member who holds the Form-editing permission.discounts:read— read discount definitions. Grantable only by a member who holds the Discounts-view permission.
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/themes"{ "meta": { "requestId": "req_019e73ce-1968-71ca-ae57-dbd8084cee79", "shopId": "example.myshopify.com", "credentialId": "cred_019e73c0", "range": { "from": "2019-08-24T14:15:22Z", "to": "2019-08-24T14:15:22Z" } }, "data": [ { "id": "string", "name": "string", "builtIn": true, "sourceThemeId": "string" } ]}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}Authorization
apiKey A Formtoro API key minted in Settings → Connections. A key carries one
or more scopes; an endpoint refuses a key that lacks its required scope
with 403 insufficient_scope. Scopes:
analytics:read— all aggregate read endpoints.customers:read— customer-level lifetime value.forms:write— create and edit forms (drafts). Grantable only by a member who holds the Form-editing permission.discounts:read— read discount definitions. Grantable only by a member who holds the Discounts-view permission.
In: header
Path Parameters
A built-in theme id (default/dark) or a custom shop theme's UUID. A non-existent / foreign id resolves to 404.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/themes/string"{ "meta": { "requestId": "req_019e73ce-1968-71ca-ae57-dbd8084cee79", "shopId": "example.myshopify.com", "credentialId": "cred_019e73c0", "range": { "from": "2019-08-24T14:15:22Z", "to": "2019-08-24T14:15:22Z" } }, "data": { "id": "string", "name": "string", "builtIn": true, "tokens": { "property1": "string", "property2": "string" }, "classMap": { "property1": "string", "property2": "string" }, "classes": { "property1": {}, "property2": {} }, "formBackground": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}Authorization
apiKey A Formtoro API key minted in Settings → Connections. A key carries one
or more scopes; an endpoint refuses a key that lacks its required scope
with 403 insufficient_scope. Scopes:
analytics:read— all aggregate read endpoints.customers:read— customer-level lifetime value.forms:write— create and edit forms (drafts). Grantable only by a member who holds the Form-editing permission.discounts:read— read discount definitions. Grantable only by a member who holds the Discounts-view permission.
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/branding"{ "meta": { "requestId": "req_019e73ce-1968-71ca-ae57-dbd8084cee79", "shopId": "example.myshopify.com", "credentialId": "cred_019e73c0", "range": { "from": "2019-08-24T14:15:22Z", "to": "2019-08-24T14:15:22Z" } }, "data": { "shopName": "string", "logoUrl": "string", "primaryColor": "string", "secondaryColor": "string", "backgroundColor": "string", "textColor": "string", "headingFont": "string", "bodyFont": "string", "cornerRadius": "string", "customBrandColors": [ { "name": "string", "hex": "string" } ] }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}