Filter and sort
Use query parameters to filter and sort the data returned by Paddle.
Most list endpoints let you filter and sort the data returned by the Paddle API.
Filter
You can filter returned results using query parameters.
For example, use the tax_category query parameter to filter products by tax category:
Return entities that match the specified tax category. Use a comma separated list to specify multiple tax categories. Results are tax exemptions that apply to all specified categories.
Check the API reference for a specific endpoint to learn more about the parameters available for filtering.
Sort
You can sort returned results using the order_by parameter, followed by a field and direction:
[ASC]to sort in ascending order[DESC]to sort in descending order
For example, to sort returned customers by name in alphabetical order:
Order returned entities by the specified field and direction ([ASC] or [DESC]).
You can sort by multiple values by joining them with a comma. For example:
Order returned entities by the specified field and direction ([ASC] or [DESC]).
The Paddle API parses sort options first to last (left to right).
Search
The list customer operation includes a search parameter that lets you search using a string. Paddle looks for the search query in the name and email fields against customer entities.
For example, to return customers with a name or email address that contains paddle:
Return entities that match a search query.
