Pagination - Users

Overview

When retrieving users 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 user data:

Parameter Description
page Specifies which page of users to display. Pages are numbered starting from 1.
items_per_page Controls how many users are included on each page. Default value is 10.
Tip: Using pagination is essential when working with large user datasets to improve performance and reduce response times.

Examples

GET /api/users?page=5

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

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

GET /api/users?items_per_page=20

This request will return 20 users from the first page.

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

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

This request will return 20 users 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 user objects based on your pagination parameters. The response will also include pagination metadata such as the current page, items per page, and total number of users available.

Note: For security reasons, sensitive user information may be omitted from responses based on your API authentication level and permissions.