Skip to content
Documentation

List Brand Profiles

GET
/api/v1/workspaces/{workspace_id}/email_design_systems/{emailDesignSystemId}/brand_profiles

Retrieves the brand profiles

Authorizations

Section titled “Authorizations ”

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

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

401

Section titled “401 ”

Unauthorized

object
message
required
string
Example
Record not found

403

Section titled “403 ”

Forbidden

object
message
required
string
Example
Record not found

404

Section titled “404 ”

Not Found

object
message
required
string
Example
Record not found