Brands

The Brands API allows you to find specific brands and retrieve lists of brands from your account.

Find Brand

QUERYbrand

Retrieves details for a specific brand by ID or name.

Arguments

Parameter	Type	Description
criteria	BrandLookupInput	Required Criteria for finding a brand

BrandLookupInput

Field	Type	Description
id	ID	Optional ID of the brand to find
name	String	Optional Name of the brand to find

Example Query

query {
  viewer {
    brand(criteria: {
      name: "Acme Inc."
    }) {
      id
      name
      website
      address
      settings {
        userMax
        fontSettings {
          mainFont {
            id
            name
          }
        }
        colourSettings {
          mainColour
          secondaryColour
        }
      }
      organisation {
        id
        name
      }
    }
  }
}

Response

{
  "data": {
    "viewer": {
      "brand": {
        "id": "QnJhbmQ6MTA=",
        "name": "Acme Inc.",
        "website": "https://acme.example.com",
        "address": "123 Main St, Anytown, USA",
        "settings": {
          "userMax": 25,
          "fontSettings": {
            "mainFont": {
              "id": "Rm9udDozNA==",
              "name": "Montserrat"
            }
          },
          "colourSettings": {
            "mainColour": "#3366FF",
            "secondaryColour": "#FF6633"
          }
        },
        "organisation": {
          "id": "T3JnYW5pc2F0aW9uOjU=",
          "name": "Acme Group"
        }
      }
    }
  }
}

List Brands

QUERYbrands

Retrieves a paginated and filterable list of brands. Requires admin access.

Arguments

Parameter	Type	Description
filter	BrandListFilterInput	Required Filter and pagination options

BrandListFilterInput

Field	Type	Description
filter	String	Optional Search term to filter brands by name
page	Int	Optional Page number for pagination (default: 1)
limit	Int	Optional Maximum number of brands to return per page (default: 10)

Example Query

query {
  viewer {
    brands(filter: {
      filter: "acme",
      page: 1,
      limit: 10
    }) {
      items {
        id
        name
        website
        organisation {
          name
        }
        users {
          id
          profile {
            firstName
            lastName
          }
        }
      }
      total
      page
      limit
      pages
    }
  }
}

Response

{
  "data": {
    "viewer": {
      "brands": {
        "items": [
          {
            "id": "QnJhbmQ6MTA=",
            "name": "Acme Inc.",
            "website": "https://acme.example.com",
            "organisation": {
              "name": "Acme Group"
            },
            "users": [
              {
                "id": "VXNlcjoyNA==",
                "profile": {
                  "firstName": "John",
                  "lastName": "Doe"
                }
              },
              {
                "id": "VXNlcjozNQ==",
                "profile": {
                  "firstName": "Jane",
                  "lastName": "Smith"
                }
              }
            ]
          },
          {
            "id": "QnJhbmQ6MTU=",
            "name": "Acme Partners",
            "website": "https://partners.acme.example.com",
            "organisation": {
              "name": "Acme Group"
            },
            "users": [
              {
                "id": "VXNlcjo0Mg==",
                "profile": {
                  "firstName": "Robert",
                  "lastName": "Johnson"
                }
              }
            ]
          }
        ],
        "total": 2,
        "page": 1,
        "limit": 10,
        "pages": 1
      }
    }
  }
}

Brand Fields

The Brand object contains the following fields:

Field	Type	Description
id	ID	Unique identifier for the brand
name	String	Name of the brand
address	String	Physical address of the brand
website	String	Website URL of the brand
settings	BrandSetting	Brand settings including fonts, colors, etc.
credits	Credit	Credits available to the brand
organisation	Organisation	The organisation this brand belongs to
users	[User]	Users associated with this brand

Working with Brands

Access Control

Access to brand data is controlled by user permissions:

• Global administrators can access any brand
• Organisation administrators can access brands within their organisation
• Regular users can only access their own brand

Brand Settings

The settings field provides access to various brand configuration options:

• userMax: Maximum number of users allowed for the brand
• fontSettings: Font configuration for the brand
• colourSettings: Color scheme for the brand
• logoSettings: Logo configurations for the brand
• messagingSettings: Settings for messaging features

Brand Credits

The credits field provides information about the brand's available credits:

• monthlyMessage: Monthly AI message limit
• shutterstock: Available Shutterstock credits
• monthlyCredits: Monthly credits allocation