steampipe plugin install zendesk

Table: zendesk_brand - Query Zendesk Brands using SQL

A Brand in Zendesk is a unique identity that you can create within your account. It includes a brand name, host mapping, subdomain, and other details. Brands in Zendesk allow you to provide customer service for multiple brands, products, or services using a single Zendesk account.

Table Usage Guide

The zendesk_brand table provides insights into Brands within Zendesk. As a customer service manager, explore brand-specific details through this table, including brand name, host mapping, subdomain, and more. Utilize it to manage and monitor multiple brands, products, or services using a single Zendesk account.


Get brand information

Explore the specific details of a particular brand in your Zendesk account to better understand its characteristics and settings. This is particularly useful when you need to assess the brand's configuration for troubleshooting or optimization purposes.

id = '1234';
id = '1234';

Schema for zendesk_brand

_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
activebooleanIf the brand is set active
brand_urltextThe URL of the brand
created_attimestamp with time zoneThe time the brand was created
defaultbooleanIs the brand the default brand for this account
has_help_centerbooleanIf the brand has a Help Center
help_center_statetextThe state of the Help Center. Allowed values are "enabled", "disabled", or "restricted".
host_mappingtextThe hostmapping to this brand, if any. Only admins can view this property.
idtext=Automatically assigned when the brand is created
logo_content_typetextThe content type of the image. Example value: "image/png"
logo_content_urltextA full URL where the attachment image file can be downloaded
logo_file_nametextThe name of the image file
logo_idbigintAutomatically assigned when created
logo_inlinebooleanIf true, the attachment is excluded from the attachment list and the attachment's URL can be referenced within the comment of a ticket. Default is false
logo_sizebigintThe size of the image file in bytes
logo_thumbnailsjsonbAn array of attachment objects
nametextThe name of the brand
signature_templatetextThe signature template for a brand
subdomaintextThe subdomain of the brand
ticket_form_idsjsonbThe ids of ticket forms that are available for use by a brand
updated_attimestamp with time zoneThe time of the last update of the brand
urltextThe API URL of the brand


This table is available as a standalone Exporter CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the script:

/bin/sh -c "$(curl -fsSL" -- zendesk

You can pass the configuration to the command with the --config argument:

steampipe_export_zendesk --config '<your_config>' zendesk_brand