Retrieves Live Pages

Authentication v1

Identity APIs
User
Address
Auth

User Self Service APIs

Introduction
User Self Service APIs
Authentication APIs

Experiences v2 (XM v2)

XM
Pages
Global Components
Menu

Experiences v1 (XM v1)

Product Catalog

Product Catalog
Category
Product
Attributes
Bulk Import

Orders v2 (OMS v2)

Order Management System
Order
Order Attribute
Developer Guide
Order Return
Payment Status
Package Tracking
Cross Border
Order Cancellation
Appeasement
Allocation
Configuration
Fraud Configuration
Target Configuration
Location
Location Attribute
Inventory Network
Inventory
Inventory Counter
Inventory Bulk Operation
Inventory Attribute
Inventory Upload Log
Shipment
Shipping Method
Webhook
Notification
Export
Invoice
Fraud
Backorder Preorder Reservation
List

Orders v1 (OMS v1)

Order Management System
Cart
Bill To
Ship To
Wishlist
Cart Decoupled
Warehouse
Inventory
Attributes
List
Tax/Address Validate
Shipping
Payments
Order

Offers v2

Offers
Developer Guide
Promotion
Price Kind
Dynamic Pricing Engine
Segment
Coupon
Coupon Codes
Product
Price List
Attributes
Item
Price Guard
Global Exclusion
Upload Price CSV
Pricing
Redemption
Exports

Offers v1

Offers
Login API
Promotions
Pricing

Subscriptions (SMT API)

Subscriptions API
Cancellation Reasons
Subscription Discounts
Subscriptions
Subscribers
Orders

Loyalty (Member)

Member APIs
Inquire
Discounts
Redeem
Earn
Members

Dropship

Dropship API
Shipments
Products
Invoices
Connections
Inventory
Developer Guide
Returns
Orders

Cart API

Cart
Order Draft
Attribute
Adjustments
Shipping
Cart

Checkout API

Checkout
Checkout

Customer

Core Concepts
Customer Service
Organization
User Party
Organization Group Addresses
User Internal Party
Organization Contracts
Party
Party Contracts
Contracts
User
Search
User Trait
Organization Users
Address
User Address
Trait
Party Address
Party Trait
Organization Group Users
Internal Party
Contract Pricelist
Internal Parties Party
Account
Party Account
Organization Addresses
Organization Groups
Individual Addresses
Users Organization
Individual

GET

pages

live

Headers

x-site-context

string

required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Response

200 - application/json

200 response object

code

string

String message of response code

message

string

Description of response action

service

string

String specifying service returned this response

status_code

integer

Represents status code of response

statusCode

integer

Represents status code of response

status

integer

The response status code

data

object

The data object holding the list of live page versions

data.livePages

object[]

The array of live page versions

data.livePages._id

string

The database id associated with the version

data.livePages.isArchived

boolean

True if the version is archived; false otherwise

data.livePages.channel

integer[]

A deprecated field holding channel information

data.livePages.channels

string[]

The channel ids associated with the version

data.livePages.status

string

The current status of the version

data.livePages.endDate

string

The date when the version will no longer be live

data.livePages.pageId

string

The database id of the page associated with the version

data.livePages.name

string

The version name

data.livePages.description

string

The description associated with the version

data.livePages.components

object[]

The list of components

data.livePages.versionId

integer

An identifier used for the version

data.livePages.createdAt

string

The date and time the version was created

data.livePages.updatedAt

string

The date and time the version was last updated

data.livePages.__v

integer

The versionKey associated with the version

data.livePages.startDate

string

The date and time the version was published

data.livePages.page

object

The page object

Was this page helpful?

Overview Retrieves Live Page By URL