Pagination - Settings

Overview

When retrieving system settings through the Venddor API, you can control how many results are returned and which page of results to display using pagination parameters.

Base URL: https://www.venddor.com.br/api

Pagination Parameters

Add these parameters to your API requests to control the pagination of system settings:

Parameter Description
page Specifies which page of settings to display. Pages are numbered starting from 1.
items_per_page Controls how many settings are included on each page. Default value is 10.
Tip: System settings can be numerous, so using pagination helps organize the results into manageable chunks, especially when you're only interested in specific groups of settings.

Examples

GET /api/settings?page=5

This request will return 10 settings from the 5th page.

Since items_per_page is not specified, the default value of 10 is used.

GET /api/settings?items_per_page=20

This request will return 20 settings from the first page.

Since page is not specified, the default value of 1 is used.

GET /api/settings?page=5&items_per_page=20

This request will return 20 settings from the 5th page.

Both pagination parameters are specified, giving you complete control over the results.

Response Format

The API will return a JSON array containing system setting objects based on your pagination parameters. Each setting object will include details like the setting name, current value, data type, and available options (where applicable).

Important: Some system settings may be read-only or have restricted access depending on your API authentication level and permissions.