iotoms Docs

Get report branding

GET
/api/v1/reports/branding

Returns the tenant's branding settings (logo, colours and company details) used on generated reports, or null if none are set.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Header Parameters

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request was handled, ERROR otherwise.

message*string

Short human-readable message describing the outcome, e.g. which record was fetched or saved.

data?

The report branding settings, or null if none have been saved yet.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/branding'
Example Response
{  "status": "string",  "message": "string",  "data": {    "tenantId": "string",    "companyName": "string",    "hasLogo": true,    "primaryColor": "string",    "secondaryColor": "string",    "footerText": "string",    "companyAddressLine1": "string",    "companyAddressLine2": "string",    "companyCountry": "string",    "companyPhone": "string",    "companyEmail": "string",    "taxRegLabel": "string",    "taxRegNumber": "string",    "currencyCode": "string",    "currencySymbol": "string",    "termsAndConditions": "string",    "updatedAt": "2019-08-24T14:15:22Z"  }}