Get page sections

GEThttps://admin.snagsolutions.io/api/page_sections

This endpoint allows you to fetch page sections

Loading code example

Loading code example

Query Parameters

websiteIdstring<uuid>required

Unique identifier for the website to filter by

organizationIdstring<uuid>required

Unique identifier for the organization to filter by

placement"global" | "page"required

Placement of the page section

Allowed values: "global" | "page"

pageIdstring<uuid>

Unique identifier for the page to filter by

all"1"

Whether to get all sections regardless of duration

Allowed values: "1"

pageSectionType"all_items" | "discovery_item" | "discovery_items_grid"

Type of the page section to filter by

Allowed values: "all_items" | "discovery_item" | "discovery_items_grid"

Response

application/json

200

idstring<uuid>required

Unique identifier for the page section

websiteIdstring<uuid>required

Unique identifier for the website

organizationIdstring<uuid>required

Unique identifier for the organization

titlestring

Title of the page section

pageSectionType"all_items" | "discovery_item" | "discovery_items_grid"

Type of the page section

Allowed values: "all_items" | "discovery_item" | "discovery_items_grid"

placement"global" | "page"required

Placement of the page section

Allowed values: "global" | "page"

sortIdnumber

Order of the page section

pageIdstring<uuid>

ID of the page this section belongs to

durationStartstring<date-time>required

Start time of the page section visibility

durationEndstring<date-time>

End time of the page section visibility

bannerobject

banner.idstring<uuid>required

banner.websiteCollectionBannersarray<object>required

banner.carouselobject

itemsGridsarray<object>

itemsGrids.idstring<uuid>required

discoveryItemsarray<object>

discoveryItems.idstring<uuid>required

discoveryItems.titlestringrequired

discoveryItems.descriptionstring

discoveryItems.layout"container_style" | "full_width_hero"

Allowed values: "container_style" | "full_width_hero"

discoveryItems.loyaltySectionstring

discoveryItems.pageMediaLinkstring

discoveryItems.mediaLinkstring

discoveryItems.websitestring

discoveryItems.twitterstring

discoveryItems.loyaltyRuleGroupIdstring

discoveryItems.sortIdnumber

discoveryItems.buttonTextstring

discoveryItems.externalLinkstring

discoveryItems.hideQuestInfoboolean

Default: false