Get layouts
/brand-api/resource/layouts
Retrieves a list of layouts for a brand.
Request
Query Params
brand_uuid
string
required
You can get brand_uuid
from the get brands endpoint.
Example:
{{brand_uuid}}
page
integer
required
> 0
Example:
1
page_size
integer
required
> 0
Example:
10
sort
string
optional
Allowed values:
created_atname
Default:
created_at
Example:
created_at
order
string
optional
Allowed values:
ascdesc
Default:
desc
Example:
desc
Request samples
Responses
List layouts(200)
Error(200)
Bad Request(400)
HTTP Code: 200
Content Type : JSON
Data Schema
layouts
array [object {4}]
required
uuid
string
required
The uuid
for which you want to download the CSV template or create a campaign.
Example:
476ba5d1-9130-4538-a1a8-925c5877980e
name
string
required
Example:
name
preview_url
string <uri>
required
It's a thumbnail link of this layout.
created_at
string
required
Example:
2021-01-01T00:00:00.000Z
meta
object
required
page
number
required
Example:
1
page_size
number
required
Example:
10
total_count
number
required
Example:
100
total_pages
number
required
Example:
10
Example
{
"layouts": [
{
"uuid": "476ba5d1-9130-4538-a1a8-925c5877980e",
"name": "name",
"preview_url": "http://example.com",
"created_at": "2021-01-01T00:00:00.000Z"
}
],
"meta": {
"page": 1,
"page_size": 10,
"total_count": 100,
"total_pages": 10
}
}
Modified at 14 hours ago