Pagination and Filtering for Call Requests

Use the following parameters to find call requests with specific properties and display them in the way you need. These parameters help you efficiently navigate and filter through your data.

Query Parameters

Parameter Default value Description
page 1 Show all call requests from the output page with the specified number.
items_per_page 10 The number of call requests displayed on one output page.
sort_by date Sort call requests by id, date, status, name, phone, user_id, user, order, order_status.
sort_order desc Ascending or descending sorting order: asc or desc.
status Filter call requests by status. Possible values: new, in_progress, completed, no_answer.
name Filter call requests by name.
phone Filter call requests by the phone number.
company_id Filter call requests by the ID of the store (if you have multiple stores).
order_status Filter call requests by the status of the associated order (made using Buy with 1-click).
user_id Filter call requests by the IDs of the administrators assigned to those requests.
order_exists Filter call requests depending on whether there is an associated order. Possible values: Y (order exists), N (order doesn't exist).
Tip: When filtering by multiple parameters, combine them using the standard query string format with "&" between parameters.

Examples

Basic Pagination

https://www.venddor.com.br/api/2.0/call_requests?items_per_page=20

This request returns an array with 20 call requests from the 1st output page.

Filtering with Multiple Parameters

https://www.venddor.com.br/api/2.0/call_requests?page=5&items_per_page=20&order_exists=N

This request returns an array with 20 call requests without associated orders from the 5th output page.

Note: Always check the total count in the response to know how many pages are available. This information is typically included in the metadata of the response.