documentBrand

Requires permission settings:documents:read.

The tenant's resolved brand identity (logo, company, accent, footer) — one value each, applied to every PDF and every document email. Falls back to the legacy per-document-type configs when no brand is saved yet.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query DocumentBrand {
  documentBrand {
    companyName
    accentColor
    companyAddress
    footerText
    logoAssetKey
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query DocumentBrand {\n  documentBrand {\n    companyName\n    accentColor\n    companyAddress\n    footerText\n    logoAssetKey\n  }\n}"
}
EOF

Response:

{
  "data": {
    "documentBrand": {
      "companyName": "string",
      "accentColor": "string",
      "companyAddress": "string",
      "footerText": "string",
      "logoAssetKey": "string"
    }
  }
}

documentBrand: DocumentBrandConfig!

Type

DocumentBrandConfig object

The organization's brand identity as it is resolved, one value each, applied to every PDF and document email.