get
https://{subdomain}.myshoplaza.com/openapi/2025-06/pages
Retrieve a list of all pages with pagination.
Requiresread_shop_navigationaccess scope.
The Get Page List API retrieves a paginated list of pages with optional filtering and sorting capabilities.
This API is especially useful for:
- Managing and reviewing all website pages programmatically.
- Building custom navigation systems or sitemaps.
- Auditing page content and SEO metadata at scale.
Request Parameters
Public Request Parameters
Query Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
cursor | string | No | The ID of the page. | 15979 |
page_size | int32 | No | Items per page (default: 10, valid range: 1-100) | 10 |
Response Explanation
Public Response Parameters
Successful Response
| Field | Type | Description | Example |
|---|---|---|---|
code | string | "success" | Status code of the response |
message | string | Descriptive message of the response | |
data.pages | array of pages | ||
data.pages.id | int | Unique ID of the page. | 15979 |
data.pages.title | string | Title of the page. | "Test" |
data.pages.content | string | HTML content of the page. | "<p>Welcome to my page!</p>" |
data.pages.status | int | Status of the page (1 for active). | 1 |
data.pages.created_at | string | Timestamp of when the page was created. | "1714377813" |
data.pages.updated_at | string | Timestamp of the last update. | "1714377813" |
data.pages.url | string | URL of the page. | "/pages/test1" |
data.pages.meta_title | string | SEO title of the page. | "Test" |
data.pages.meta_keyword | string | SEO keywords for the page. | "" |
data.pages.meta_description | string | SEO description of the page. | "Welcome to my page!" |
data.pages.independent_seo | boolean | Whether SEO is managed independently. | false |
data.has_more | boolean | true | true if there is more results, others else |
data.cursor | string | 165618e4-3243-4cd7-abc3-1234567890ab | A cursor used for pagination to navigate through the list. |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |