Use the following parameters to find pages with specific properties and display them in a way that meets your requirements. These parameters help you efficiently retrieve and organize page data through the API.
Retrieves a list of pages based on specified filtering criteria.
| Parameter | Default value | Description |
|---|---|---|
page |
1 |
Show all pages on the output page with the specified number. |
items_per_page |
10 |
The number of pages displayed on the output page. |
| Parameter | Default value | Description |
|---|---|---|
sort_by |
position |
Sort pages by position, name, timestamp, type, multi_level. |
sort_order |
desc |
Ascending or descending sorting order: asc or desc. |
| Parameter | Default value | Description |
|---|---|---|
parent_id |
Filter pages by the ID of the parent element. | |
page_type |
Filter pages by type. Possible values:
T - page
L - link
F - form (only available with the Form Builder add-on)
B - blog post (available only with the Blog add-on) |
|
simple |
Add this parameter if you don't want the response to include the content of the pages. | |
q |
Full-text filtering. | |
status |
Filter pages by status. Possible values:
A - active
H - hidden
D - disabled |
|
item_ids |
Show only specific pages. Separate the IDs with commas. | |
get_tree |
Show pages as a tree. Values: true, plain. |
simple parameter to improve performance when you only need page metadata and not the full content.
https://www.venddor.com.br/api/2.0/pages?page=5
Response is an array with 10 pages from the 5th output page.
https://www.venddor.com.br/api/2.0/pages?items_per_page=20
Response is an array with 20 pages from the first page.
https://www.venddor.com.br/api/2.0/pages?page=5&items_per_page=20
Response is an array with 20 pages from the 5th page.
get_tree=true parameter, the response structure will include parent-child relationships, making it easier to build hierarchical menus or sitemaps.