Skip to main content
GET
Get page sections

Query Parameters

websiteId
string<uuid>
required

Unique identifier for the website to filter by

Example:

"123e4567-e89b-12d3-a456-426614174333"

organizationId
string<uuid>
required

Unique identifier for the organization to filter by

Example:

"123e4567-e89b-12d3-a456-426614174334"

placement
enum<string>
required

Placement of the page section

Available options:
global,
page
Example:

"page"

pageId
string<uuid>

Unique identifier for the page to filter by

Example:

"123e4567-e89b-12d3-a456-426614174336"

all
enum<string>

Whether to get all sections regardless of duration

Available options:
1
Example:

"1"

pageSectionType
enum<string> | null

Type of the page section to filter by

Available options:
all_items,
discovery_item,
discovery_items_grid
Example:

"page"

Response

200

id
string<uuid>
required

Unique identifier for the page section

Example:

"123e4567-e89b-12d3-a456-426614174337"

websiteId
string<uuid>
required

Unique identifier for the website

Example:

"123e4567-e89b-12d3-a456-426614174333"

organizationId
string<uuid>
required

Unique identifier for the organization

Example:

"123e4567-e89b-12d3-a456-426614174334"

placement
enum<string>
required

Placement of the page section

Available options:
global,
page
Example:

"page"

durationStart
string<date-time>
required

Start time of the page section visibility

Example:

"2023-01-01T00:00:00.000Z"

title
string | null

Title of the page section

Example:

"Featured Collection"

pageSectionType
enum<string> | null

Type of the page section

Available options:
all_items,
discovery_item,
discovery_items_grid
Example:

"discovery_items_grid"

sortId
number

Order of the page section

Example:

1

pageId
string<uuid>

ID of the page this section belongs to

Example:

"123e4567-e89b-12d3-a456-426614174336"

durationEnd
string<date-time> | null

End time of the page section visibility

Example:

"2023-12-31T23:59:59.999Z"

banner
object | null
itemsGrids
object[]
discoveryItems
object[]