Retrieve a list of all pages
Request
- Base URLhttps://shop-name.onshopbase.com
- AuthAPI key in header APP_ACCESS_TOKEN
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
The maximum number of results to show.
Restrict results to after the specified ID.
Retrieve pages with a given title.
Retrieve a page with a given handle.
Show pages created after date (format: 2008-12-31).
Show pages created before date (format: 2008-12-31).
Show pages last updated after date (format: 2008-12-31).
Show pages last updated before date (format: 2008-12-31).
Show pages last updated before date (format: 2008-12-31).
Show pages published after date (format: 2014-04-25T16:15:47-04:00).
Show only certain fields, specified by a comma-separated list of field names.
Restrict results to pages with a given published status: <br> * published: Show only published pages. <br> * unpublished: Show only unpublished pages. <br> * any: Show published and unpublished pages.
Response
OK
Example response
{
"pages": [
{
"body_html": "Contact us at <a href=\\"mailto:contact@johns-apparel.com\\">contact@johns-apparel.com</a>",
"handle": "contact-us",
"id": 131092082,
"publish": true,
"search_engine_meta_description": "Contact us at contact@johns-apparel.com",
"search_engine_title": "Contact us",
"template": "contact_us",
"title": "Contact us"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.