Branding
Get your brand draft
The editable copy of your brand, with short-lived preview links to its logo and icon and what Flow has switched on for your account (entitlement, read-only). Nobody else sees the draft until it is published. version is 0 before the first save. canChange says whether you can change the brand; one-organisation administrators can view only. The ETag header is the version as an entity tag; send it back as If-Match to change the draft.
GET
/
customer
/
branding
/
draft
Get your brand draft
curl --request GET \
--url https://api.sandbox.flowpayroll.ai/v1/administration/customer/branding/draft \
--header 'X-Auth-Token: <api-key>'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/administration/customer/branding/draft"
headers = {"X-Auth-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Auth-Token': '<api-key>'}};
fetch('https://api.sandbox.flowpayroll.ai/v1/administration/customer/branding/draft', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.flowpayroll.ai/v1/administration/customer/branding/draft",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Auth-Token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.flowpayroll.ai/v1/administration/customer/branding/draft"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Auth-Token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.flowpayroll.ai/v1/administration/customer/branding/draft")
.header("X-Auth-Token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/administration/customer/branding/draft")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Auth-Token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": {
"settings": {
"productName": "<string>",
"primaryColour": "<string>",
"primaryForegroundColour": "<string>",
"accentColour": "<string>",
"fontSource": "Curated",
"fontCuratedKey": "<string>",
"fontFamily": "<string>",
"fontRegularAssetId": "<string>",
"fontMediumAssetId": "<string>",
"fontBoldAssetId": "<string>",
"fontLicenceConfirmedBy": "<string>",
"fontLicenceConfirmedDate": "<string>",
"logoAssetId": "<string>",
"iconAssetId": "<string>",
"supportEmail": "<string>",
"supportUrl": "<string>",
"privacyUrl": "<string>",
"termsUrl": "<string>",
"helpLinksFallback": "Hide",
"emailFromName": "<string>",
"emailFromAddress": "<string>",
"emailSenderOverrides": {},
"emailReplyTo": "<string>",
"emailFooterText": "<string>",
"legalFooter": "<string>",
"documentsShowLogo": true,
"documentsUseBrandColour": true,
"appShowsProductName": true,
"signInShowsProductName": true,
"emailsShowProductName": true,
"documentsShowProductName": true,
"logoDarkAssetId": "<string>",
"iconDarkAssetId": "<string>",
"loadingStyle": "Spinner",
"loadingAnimationAssetId": "<string>",
"loadingAnimationDarkAssetId": "<string>",
"emailButtonShape": "Rounded",
"emailHeaderStyle": "Plain"
},
"previews": {
"logoSvgUrl": "<string>",
"iconSvgUrl": "<string>",
"logoDarkSvgUrl": "<string>",
"iconDarkSvgUrl": "<string>",
"loadingAnimationSvgUrl": "<string>",
"loadingAnimationDarkSvgUrl": "<string>"
},
"entitlement": {
"whiteLabelEnabled": true,
"poweredByFlow": true,
"domainAllowance": 123,
"sendingDomainAllowance": 123
},
"version": 123,
"updatedDate": "<string>",
"updatedBy": "<string>",
"canChange": true
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}Was this page helpful?
⌘I
Get your brand draft
curl --request GET \
--url https://api.sandbox.flowpayroll.ai/v1/administration/customer/branding/draft \
--header 'X-Auth-Token: <api-key>'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/administration/customer/branding/draft"
headers = {"X-Auth-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Auth-Token': '<api-key>'}};
fetch('https://api.sandbox.flowpayroll.ai/v1/administration/customer/branding/draft', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.flowpayroll.ai/v1/administration/customer/branding/draft",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Auth-Token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.flowpayroll.ai/v1/administration/customer/branding/draft"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Auth-Token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.flowpayroll.ai/v1/administration/customer/branding/draft")
.header("X-Auth-Token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/administration/customer/branding/draft")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Auth-Token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": {
"settings": {
"productName": "<string>",
"primaryColour": "<string>",
"primaryForegroundColour": "<string>",
"accentColour": "<string>",
"fontSource": "Curated",
"fontCuratedKey": "<string>",
"fontFamily": "<string>",
"fontRegularAssetId": "<string>",
"fontMediumAssetId": "<string>",
"fontBoldAssetId": "<string>",
"fontLicenceConfirmedBy": "<string>",
"fontLicenceConfirmedDate": "<string>",
"logoAssetId": "<string>",
"iconAssetId": "<string>",
"supportEmail": "<string>",
"supportUrl": "<string>",
"privacyUrl": "<string>",
"termsUrl": "<string>",
"helpLinksFallback": "Hide",
"emailFromName": "<string>",
"emailFromAddress": "<string>",
"emailSenderOverrides": {},
"emailReplyTo": "<string>",
"emailFooterText": "<string>",
"legalFooter": "<string>",
"documentsShowLogo": true,
"documentsUseBrandColour": true,
"appShowsProductName": true,
"signInShowsProductName": true,
"emailsShowProductName": true,
"documentsShowProductName": true,
"logoDarkAssetId": "<string>",
"iconDarkAssetId": "<string>",
"loadingStyle": "Spinner",
"loadingAnimationAssetId": "<string>",
"loadingAnimationDarkAssetId": "<string>",
"emailButtonShape": "Rounded",
"emailHeaderStyle": "Plain"
},
"previews": {
"logoSvgUrl": "<string>",
"iconSvgUrl": "<string>",
"logoDarkSvgUrl": "<string>",
"iconDarkSvgUrl": "<string>",
"loadingAnimationSvgUrl": "<string>",
"loadingAnimationDarkSvgUrl": "<string>"
},
"entitlement": {
"whiteLabelEnabled": true,
"poweredByFlow": true,
"domainAllowance": 123,
"sendingDomainAllowance": 123
},
"version": 123,
"updatedDate": "<string>",
"updatedBy": "<string>",
"canChange": true
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}