{"info":{"_postman_id":"6752225f-21ef-408c-81fb-de035d89364d","name":"Brandworkz Essentials API","description":"<html><head></head><body><p>The Brandworkz Essentials API allows you to interact with the data stored within your Brandworkz Essentials system.<br>\nIt is intended for developers who are writing standalone applications or integrations that incorporate content from\nBrandworkz Essentials.</p>\n<h1 id=\"authentication\">Authentication</h1>\n<p>The Brandworkz Essentials API uses API keys to authenticate requests. You can view and manage your API keys in the\nBrandworkz Essentials <em>Organisation Settings</em> page.</p>\n<p>Your API keys have access to private data and contain many privileges, so be sure to keep them secure!</p>\n<p>Authentication to the API is performed by providing the HTTP Authorization request header with the key value.\n<code>Authorization: Bearer {API_KEY}</code></p>\n<p>All API requests must be made over HTTPS.<br>\nCalls made over plain HTTP will fail.<br>\nAPI requests without authentication will also fail.</p>\n<h1 id=\"errors\">Errors</h1>\n<p>Brandworkz Essentials uses conventional HTTP response codes to indicate the success or failure of an API request.</p>\n<p>In general:</p>\n<ul>\n<li>Codes in the 2xx range indicate success.<br></li>\n<li>Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was\nomitted, etc.).<br></li>\n<li>Codes in the 5xx range indicate an error with Brandworkz Essential's servers.</li>\n</ul>\n<p>The most common errors you can encounter in the Brandworkz Essentials API are as follows:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>HTTP Status Code</th>\n<th>Error Message</th>\n<th>Cause</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>403</td>\n<td>Access Denied</td>\n<td>You are trying to access the API without authenticating/permission.</td>\n</tr>\n<tr>\n<td>400</td>\n<td>Bad Request</td>\n<td>The request does not match the endpoint definition.</td>\n</tr>\n<tr>\n<td>500</td>\n<td>Internal Server Error</td>\n<td>Something went wrong at Brandworkz Essentials side.</td>\n</tr>\n</tbody>\n</table>\n</div></body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"Errors","slug":"errors"}],"owner":"7812900","collectionId":"6752225f-21ef-408c-81fb-de035d89364d","publishedId":"UzryZSSc","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-08-03T10:25:07.000Z"},"item":[{"name":"Endpoints","item":[{"name":"/brands","id":"54433942-7ff5-46d6-a105-68e190dc9a74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"Accept","value":"application/json"}],"url":"https://main-api.brandworkz.com/brands","description":"<blockquote>\n<p>Returns all the brands stored in the system.</p>\n</blockquote>\n<p><strong>RESPONSE</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"data\" : [ {\n    \"id\" : \"string\",\n    \"systemRef\" : \"string\",\n    \"name\" : \"string\",\n    \"createdOn\" : \"number\",\n    \"updatedOn\" : \"number\"\n  } ]\n}\n\n</code></pre>\n","urlObject":{"protocol":"https","path":["brands"],"host":["main-api","brandworkz","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"54433942-7ff5-46d6-a105-68e190dc9a74"},{"name":"/brands/elements/colours","id":"91ee9c60-e868-4cb7-9c42-466f490af9f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-brand","value":"{{x-brand}}","description":"<p>Limit down to a particular brand(s) by passing in the brand system reference(s). If not provided, then the results will be filtered against the default brand</p>\n"},{"key":"Authorization","value":"{{Authorization}}","description":"<p>Passes to the application a Bearer Token, to authenticate that the user has access</p>\n"},{"key":"Accept","value":"application/json"}],"url":"https://main-api.brandworkz.com/brands/elements/colours?group={{group}}&status={{status}}&colour-mode={{colour-mode}}","description":"<blockquote>\n<p>Return information for on-brand and off-brand colours stored on the system. Optionally limit down colours for a specific brand, status, group and or colour mode</p>\n</blockquote>\n<p><strong>RESPONSE</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"data\" : [ {\n    \"cmyk\" : { },\n    \"name\" : \"string\",\n    \"hex\" : { },\n    \"id\" : \"string\",\n    \"pantone\" : { },\n    \"rgb\" : { },\n    \"group\" : \"string\",\n    \"status\" : \"string\"\n  } ]\n}\n</code></pre>\n","urlObject":{"protocol":"https","path":["brands","elements","colours"],"host":["main-api","brandworkz","com"],"query":[{"description":{"content":"<p>Limit down to a particular group(s) or leave blank to bring back colours for all groups . When passing in multiple values they need to be comma separated. Allowed values are: primary, secondary, tertiary</p>\n","type":"text/plain"},"key":"group","value":"{{group}}"},{"description":{"content":"<p>Limit down to a particular status or leave blank to return values for both on and off brand colours. Default value is on-brand. Allowed values are: on-brand, off-brand</p>\n","type":"text/plain"},"key":"status","value":"{{status}}"},{"description":{"content":"<p>Limit down to return values for a particular colour mode(s) or leave blank to return all colour values When passing in multiple they must be comma separated. Allowed values are: hex, rgb, cmyk, pantone</p>\n","type":"text/plain"},"key":"colour-mode","value":"{{colour-mode}}"}],"variable":[]}},"response":[],"_postman_id":"91ee9c60-e868-4cb7-9c42-466f490af9f9"},{"name":"/brands/elements/fonts","id":"85d15ca7-fc30-4d83-9529-bf6393a47d41","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-brand","value":"{{x-brand}}","description":"<p>Limit down to a particular brand(s) by passing in the brand system reference(s). If not provided, then the results will be filtered against the default brand</p>\n"},{"key":"Authorization","value":"{{Authorization}}","description":"<p>Passes to the application a Bearer Token, to authenticate that the user has access</p>\n"},{"key":"Accept","value":"application/json"}],"url":"https://main-api.brandworkz.com/brands/elements/fonts?status={{status}}&fileType={{fileType}}&usage={{usage}}&family={{family}}","description":"<blockquote>\n<p>Return information for on-brand and off-brand fonts stored on the system. Optionally limit down fonts for a specific brand, status, filetype, usage and or family</p>\n</blockquote>\n<p><strong>RESPONSE</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"data\" : [ {\n    \"fonts\" : [ {\n      \"name\" : \"string\",\n      \"files\" : [ {\n        \"filetype\" : \"string\",\n        \"filename\" : \"string\",\n        \"usage\" : \"string\",\n        \"url\" : \"string\",\n        \"status\" : \"string\"\n      } ]\n    } ],\n    \"family\" : \"string\"\n  } ]\n}\n</code></pre>\n","urlObject":{"protocol":"https","path":["brands","elements","fonts"],"host":["main-api","brandworkz","com"],"query":[{"description":{"content":"<p>Limit down to a particular status or leave blank to return values for both on and off brand fonts. Default value is on-brand. Allowed values are: on-brand, off-brand</p>\n","type":"text/plain"},"key":"status","value":"{{status}}"},{"description":{"content":"<p>Limit down on which filetypes to return or leave blank to return all filetypes. When passing in multiple values they need to be comma separated. Allowed values are TTF, OTF, WOFF, WOFF2. Values can either be in lower or uppercase</p>\n","type":"text/plain"},"key":"fileType","value":"{{fileType}}"},{"description":{"content":"<p>Limit down to a particular usage type or leave blank to return fonts for all usage types . When passing in multiple values they need to be comma separated. Allowed values are: office, web, print</p>\n","type":"text/plain"},"key":"usage","value":"{{usage}}"},{"description":{"content":"<p>Limit down to a specific family, e.g. 'Source Sans Pro'.This will limit down on a specific font family. Note that you can also specify the name without spaces to avoid any problems with the URL encoding</p>\n","type":"text/plain"},"key":"family","value":"{{family}}"}],"variable":[]}},"response":[],"_postman_id":"85d15ca7-fc30-4d83-9529-bf6393a47d41"},{"name":"/brands/elements/logos","id":"b3bc2557-d631-429d-9c81-f5301e2de47f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-brand","value":"{{x-brand}}","description":"<p>Limit down to a particular brand(s) by passing in the brand system reference(s). If not provided, then the results will be filtered against the default brand</p>\n"},{"key":"Authorization","value":"{{Authorization}}","description":"<p>Passes to the application a Bearer Token, to authenticate that the user has access</p>\n"},{"key":"Accept","value":"application/json"}],"url":"https://main-api.brandworkz.com/brands/elements/logos?background={{background}}&status={{status}}&fileType={{fileType}}&usage={{usage}}","description":"<blockquote>\n<p>Return information for for on-brand and off-brand logos stored on the system. Optionally limit down logos for a specific brand, status, filetype, usage and or background</p>\n</blockquote>\n<p><strong>RESPONSE</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"data\" : [ {\n    \"background\" : \"string\",\n    \"usage\" : [ { } ],\n    \"id\" : \"string\",\n    \"title\" : \"string\",\n    \"status\" : \"string\"\n  } ]\n}\n</code></pre>\n","urlObject":{"protocol":"https","path":["brands","elements","logos"],"host":["main-api","brandworkz","com"],"query":[{"description":{"content":"<p>Limit down on logos to be used on a particular background eg dark background or leave blank to return both. Allowed values are: light, dark</p>\n","type":"text/plain"},"key":"background","value":"{{background}}"},{"description":{"content":"<p>Limit down to a particular status or leave blank to return values for both on and off brand logos. Default value is on-brand. Allowed values are: on-brand, off-brand</p>\n","type":"text/plain"},"key":"status","value":"{{status}}"},{"description":{"content":"<p>Limit down on which filetypes to return or leave blank to return all filetypes. When passing in multiple values they need to be comma separated. Allowed values are AI, EPS, PDF, SVG, GIF, PNG, JPG, TIF, WEBP can can be either lower or uppercase.</p>\n","type":"text/plain"},"key":"fileType","value":"{{fileType}}"},{"description":{"content":"<p>Limit down to a particular usage type or leave blank to bring logos for all usage types. When passing in multiple values they need to be comma separated. Allowed values are: digital, office, print and icon.</p>\n","type":"text/plain"},"key":"usage","value":"{{usage}}"}],"variable":[]}},"response":[],"_postman_id":"b3bc2557-d631-429d-9c81-f5301e2de47f"},{"name":"/brands/elements/styles","id":"9a2c28b9-99aa-4eaa-856c-14ec6baf47db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-brand","value":"{{x-brand}}","description":"<p>Limit down to a particular brand(s) by passing in the brand system reference(s).  If not provided, then the results will be filtered against the default brand</p>\n"},{"key":"Authorization","value":"{{Authorization}}","description":"<p>Passes to the application a Bearer Token, to authenticate that the user has access</p>\n"},{"key":"Accept","value":"application/json"}],"url":"https://main-api.brandworkz.com/brands/elements/styles?status={{status}}&usage={{usage}}","description":"<blockquote>\n<p>Returns data for on-brand and off-brand styes stored on the system. Optionally limit down fonts for a specific brand, status or usage</p>\n</blockquote>\n<p><strong>RESPONSE</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"data\" : [ {\n    \"letterCase\" : \"string\",\n    \"htmlTag\" : \"string\",\n    \"wordSpacing\" : \"string\",\n    \"usage\" : [ { } ],\n    \"letterSpacing\" : \"string\",\n    \"brandStatus\" : \"string\",\n    \"tracking\" : \"string\",\n    \"defaultBackgroundColour\" : \"string\",\n    \"spaceAfter\" : \"string\",\n    \"spaceBefore\" : \"string\",\n    \"fontId\" : \"string\",\n    \"size\" : \"string\",\n    \"backgroundColourId\" : \"string\",\n    \"fontColourId\" : \"string\",\n    \"defaultFontColour\" : \"string\",\n    \"letterWeight\" : \"string\",\n    \"name\" : \"string\",\n    \"lineHeight\" : \"string\",\n    \"id\" : \"string\",\n    \"alignment\" : \"string\",\n    \"decoration\" : \"string\",\n    \"order\" : 0,\n    \"status\" : \"string\"\n  } ]\n}\n</code></pre>\n","urlObject":{"protocol":"https","path":["brands","elements","styles"],"host":["main-api","brandworkz","com"],"query":[{"description":{"content":"<p>Limit down to a particular status or leave blank to return both on and off brand styles. Allowed values are on-brand or off-brand</p>\n","type":"text/plain"},"key":"status","value":"{{status}}"},{"description":{"content":"<p>Limit down to a particular usage type or leave blank to return styles for all usage types . When passing in multiple values they need to be comma separated. Allowed values are: office, web, print</p>\n","type":"text/plain"},"key":"usage","value":"{{usage}}"}],"variable":[]}},"response":[],"_postman_id":"9a2c28b9-99aa-4eaa-856c-14ec6baf47db"}],"id":"9f3676e6-f9c9-449e-9b7b-1a9ba8fcbfb3","_postman_id":"9f3676e6-f9c9-449e-9b7b-1a9ba8fcbfb3","description":""}]}