Brand Theme Collection

Description

A collection of brand themes

Properties

Property Description
items

A collection of resources returned in the current result set.

Property Description
emailBrandLogo nullable

The brand logo for use in email messages (and any other place using a white/neutral background).

id

The identifier of this brand theme.

links required read-only

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.

name

The name of this brand theme.

type

The type of object represented.

links required read-only

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.

meta read-only

Metadata describing the current result set.

Property Description
currentPage

The current page of results returned.

rows

The number of rows returned per page for the current result set.

totalItems

The total number of items in the result set. This may be affected by active search/filter parameters.

totalPages

The total number of pages in the result set. This is affected by the rows parameter (totalItems / rows == totalPages).

type

The type of resource represented.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "A collection of brand themes",
  "properties": {
    "items": {
      "description": "A collection of resources returned in the current result set.",
      "items": {
        "description": "A brand theme.",
        "properties": {
          "emailBrandLogo": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BrandLogo"
              },
              {
                "nullable": true
              }
            ],
            "description": "The brand logo for use in email messages (and any other place using\na white/neutral background)."
          },
          "id": {
            "description": "The identifier of this brand theme.",
            "type": "integer"
          },
          "links": {
            "$ref": "#/components/schemas/Links"
          },
          "name": {
            "description": "The name of this brand theme.",
            "type": "string"
          },
          "type": {
            "description": "The type of object represented.",
            "enum": [
              "brand-theme"
            ],
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "meta": {
      "description": "Metadata describing the current result set.",
      "properties": {
        "currentPage": {
          "description": "The current page of results returned.",
          "type": "integer"
        },
        "rows": {
          "description": "The number of rows returned per page for the current result set.",
          "type": "integer"
        },
        "totalItems": {
          "description": "The total number of items in the result set. This may be\naffected by active search/filter parameters.",
          "type": "integer"
        },
        "totalPages": {
          "description": "The total number of pages in the result set. This is affected by\nthe `rows` parameter (`totalItems / rows == totalPages`).",
          "type": "integer"
        }
      },
      "readOnly": true,
      "type": "object"
    },
    "type": {
      "description": "The type of resource represented.",
      "enum": [
        "brand-theme-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Collection",
  "type": "object"
}