Common GET Parameters

The common query parameters in the GET requests are:
Parameter
Description
from_date
Filter the query from this date. In a timestamp.
to_date
Filter the query to this date. In a timestamp.
date_filter
Which date should the from_date and to_date be filtered by. The default is created. Other examples are modified and payment_date.
size
Set the maximum number of items returned in the response.
page
Choose which page the results come from, based on size .
status
Most of the Building Blocks have statuses. Filter by one or multiple statuses separated by a comma.
sort
Sort the results of a given field by ascending order. Put a minus (-) in front of the sorting parameter and it will be sorted in descending order.
Python SDK
Core SDK & Node SDK
Python SDK
builton.order().get_all(sort='-created')
Core SDK & Node SDK
builton.orders.get({
  size: 1,
  page: 0,
  urlParams: { sort: '-created' }
}).then(console.log);
​
// The pagination parameters are set by default,
// the rest of the parameters are to be set in `urlParams`.
See Pagination for more details about paginating with the Core SDK and the Node SDK.

Nuts & Bolts - Previous

Errors

Next - Nuts & Bolts

Common Object Fields

Last updated 8 months ago

Parameter	Description
`from_date`	Filter the query from this date. In a timestamp.
`to_date`	Filter the query to this date. In a timestamp.
`date_filter`	Which date should the `from_date` and `to_date` be filtered by. The default is `created`. Other examples are `modified` and `payment_date`.
`size`	Set the maximum number of items returned in the response.
`page`	Choose which page the results come from, based on `size` .
`status`	Most of the Building Blocks have statuses. Filter by one or multiple statuses separated by a comma.
`sort`	Sort the results of a given field by ascending order. Put a minus (`-`) in front of the sorting parameter and it will be sorted in descending order.