Skip to content
Documentation

List Layouts

GET
/api/v1/workspaces/{workspace_id}/layouts

Retrieves the layouts.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace_id
required
integer

Workspace ID

Query Parameters

Section titled “Query Parameters ”
email_design_system_id
integer

Email Design System ID

brand_profile_id
One of:
integer
>= 1

Brand Profile ID

Example
123
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
12345
name
required
string
Example
Admin
content
required
object
container_component_instance
required
object
id
required
string
Example
bd1c1b82-1a7b-4f0f-b079-30c1d4189bed
name
string
Example
My Component
component_id
required
integer
conditional_id
integer
field_values
object
key
additional properties
object
key
additional properties
object
key
additional properties
object
value
required
One of:
string
link_tracking_parameters
object
key
additional properties
string
hidden_from_locales
object
key
additional properties
boolean
Example
true
component_instances
required
Array<object>
object
id
required
string
Example
bd1c1b82-1a7b-4f0f-b079-30c1d4189bed
name
string
Example
My Component
component_id
required
integer
conditional_id
integer
field_values
object
key
additional properties
object
key
additional properties
object
key
additional properties
object
value
required
One of:
string
link_tracking_parameters
object
key
additional properties
string
hidden_from_locales
object
key
additional properties
boolean
Example
true
email_design_system_id
required
integer
Example
12345
brand_profile_id
required
integer
nullable
Example
12345
locales
required
Array<string>
Allowed values: ar-SA bn-BD bn-IN ca-ES cs-CZ da-DK de-AT de-CH de-DE el-GR en-AU en-CA en-GB en-IE en-IN en-NZ en-US en-ZA es-AR es-CL es-CO es-ES es-MX es-US fi-FI fr-BE fr-CA fr-CH fr-FR he-IL hi-IN hu-HU id-ID it-CH it-IT ja-JP ko-KR nl-BE nl-NL no-NO pl-PL pt-BR pt-PT ro-RO ru-RU sk-SK sv-SE ta-IN ta-LK th-TH tr-TR zh-CN zh-HK
created_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z
updated_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z
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