Brand Theme Collection

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": {
          "colorScheme": {
            "description": "The color scheme for this brand theme.\n\n| ShootProof Identifier | Description |\n| --------------------- | ----------- |\n| `dark` | A \"dark\" color scheme should be used when displaying this brand theme. |\n| `light` | A \"light\" color scheme should be used when displaying this brand theme. |",
            "enum": [
              "dark",
              "light"
            ],
            "type": "string"
          },
          "created": {
            "$ref": "#/components/schemas/Signature/properties/created"
          },
          "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 such as contracts and invoices)."
          },
          "eventBrandLogo": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BrandLogo"
              },
              {
                "nullable": true
              }
            ],
            "description": "The brand logo for use in event presentation."
          },
          "fontSet": {
            "description": "The font set for this brand theme.\n\n| ShootProof Identifier | Primary Font Name | Secondary Font Name | Body Font Name |\n| --------------------- | ----------------- | ------------------- | -------------- |\n| `brandon` | Brandon | Brandon | Baskerville |\n| `freeland` | ProximaNova | Freeland | ProximaNova |\n| `baskerville` | Baskerville | Baskerville | OpenSans-Regular |\n| `blooming-elegant` | BloomingElegant-Regular | BloomingElegant-Regular | Brandon |\n| `bambusa-pro-regular` | BambusaPro-Regular | BambusaPro-Regular | OpenSans-Regular |\n| `scandiebox-one` | SBOne | SBOne | OpenSans-Regular |",
            "enum": [
              "brandon",
              "freeland",
              "baskerville",
              "blooming-elegant",
              "bambusa-pro-regular",
              "scandiebox-one"
            ],
            "type": "string"
          },
          "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"
          },
          "primaryColor": {
            "description": "The primary hex color code for this brand theme.",
            "example": "777777",
            "type": "string"
          },
          "secondaryColor": {
            "description": "The secondary hex color code for this brand theme.",
            "example": "ffffff",
            "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"
}