publicBrandingSettings

Public: no authentication required.

Returns an organization's logo, favicon, company name and primary color for its sign-in page. Needs no sign-in. Without an organization, or if it cannot be read, it returns default branding.

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 PublicBrandingSettings {
  publicBrandingSettings {
    companyName
    faviconUrl
    logoUrl
    primaryColor
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query PublicBrandingSettings {\n  publicBrandingSettings {\n    companyName\n    faviconUrl\n    logoUrl\n    primaryColor\n  }\n}"
}
EOF

Response:

{
  "data": {
    "publicBrandingSettings": {
      "companyName": "string",
      "faviconUrl": "string",
      "logoUrl": "string",
      "primaryColor": "string"
    }
  }
}

publicBrandingSettings(
  organizationId: String
): PublicBrandingSettings!

Arguments

publicBrandingSettings.organizationId ● String scalar

The ID of the organization.

Type

PublicBrandingSettings object

The branding anyone may read, without signing in.