Skip to content
Documentation

List Brand Profiles

GET
/api/v1/workspaces/{workspace_id}/email_design_systems/{emailDesignSystemId}/brand_profiles
curl --request GET \
  --url 'https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/email_design_systems/1/brand_profiles?per=10&page=1&sort=created_at_asc' \
  --header 'Authorization: Bearer <token>'

Retrieves the brand profiles

Authorizations

Section titled “Authorizations”
  • OAuth2
    email_design_systems:read

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace_id
required
integer

Workspace ID

emailDesignSystemId
required
integer

Email Design System ID

Query Parameters

Section titled “Query Parameters”
per
integer
default: 10

Number of records per page

page
integer
default: 1

Page number

sort
string
Allowed values: created_at_asc created_at_desc updated_at_asc updated_at_desc name_asc name_desc

Sorting

Responses

Section titled “Responses”

200

Section titled “200”

Successful

Media typeapplication/json
object
results
required
Array<object>
object
id
required
integer
name
required
string
component_overrides
required
Array<object>
object
component_name
required
string
hidden
required

When a component is hidden, it is not available for selection within the email editor.

boolean
field_overrides
required

Overrides for individual field defaults when this brand profile is active.

Array<object>
object
liquid_variable
required
string
default_value
One of:
string
hidden_in_editor
boolean
hidden_from_ai
boolean
label
string
design_tokens
required
object
key
additional properties
any
created_at
required
string format: date-time
updated_at
required
string format: date-time
email_design_system_id
required
integer
pagination
required
object
per
required
integer
page
required
integer
total
required
integer
Example
{
  "results": [
    {
      "id": 1,
      "name": "My Brand",
      "component_overrides": [
        {
          "component_name": "Headline",
          "hidden": false,
          "field_overrides": [
            {
              "liquid_variable": "headline",
              "default_value": "Hello, world!",
              "hidden_in_editor": false,
              "hidden_from_ai": false,
              "label": "Headline"
            }
          ]
        }
      ],
      "design_tokens": {
        "primary_button_color": "#007bff",
        "secondary_button_color": "#6c757d"
      },
      "created_at": "2021-01-01T00:00:00Z",
      "updated_at": "2021-01-01T00:00:00Z",
      "email_design_system_id": 1
    }
  ],
  "pagination": {
    "per": 10,
    "page": 1,
    "total": 100
  }
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}