get https://{shopdomain}.myshoplaza.com/openapi/2022-01/pages
Requires
read_shop_navigationaccess scope. More access scope
The Get Page List API retrieves a paginated list of all pages available in the store, including metadata and content.
This API is especially useful for:
- Fetching a list of all pages for management or display.
- Automating workflows that involve multiple pages.
- Debugging or auditing page metadata.
Request Parameters
Public Request Parameters
Query Parameters
| Parameter | Type | Description | Required | Example |
|---|---|---|---|---|
page | int32 | Page number (defaults to 1). | No | 1 |
per_page | int32 | Number of items per page (defaults to 50). | No | 50 |
Response Explanation
Public Response Parameters
Successful Response
| Field | Type | Description | Example |
|---|---|---|---|
page | int32 | Current page number. | 1 |
per_page | int32 | Number of pages returned per page. | 50 |
pages[].id | int | Unique ID of the page. | 15979 |
pages[].store_id | int | Store ID to which the page belongs. | 633130 |
pages[].title | string | Title of the page. | "Test" |
pages[].content | string | HTML content of the page. | "<p>Welcome to my page!</p>" |
pages[].status | int | Status of the page (1 for active). | 1 |
pages[].created_at | string | Timestamp of when the page was created. | "1714377813" |
pages[].updated_at | string | Timestamp of the last update. | "1714377813" |
pages[].url | string | URL of the page. | "/pages/test1" |
pages[].meta_title | string | SEO title of the page. | "Test" |
pages[].meta_keyword | string | SEO keywords for the page. | "" |
pages[].meta_description | string | SEO description of the page. | "Welcome to my page!" |
pages[].independent_seo | boolean | Whether SEO is managed independently. | false |
count | int32 | Total number of pages. | 2 |
has_more | boolean | Indicates if more pages exist. | 0 |
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "store is not active" | Indicates an error encountered during the process |
Error Detail
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 400 | Bad Request | Invalid input format or request structure (e.g., missing required fields or incorrect data types). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized |