Query parameters all
Nullability
The required Header and Query Parameters will be marked with * before the parameter name, while optional parameters will not be marked.
Deprecation
Deprecated Header and Query Parameters will be strikethrough and marked with , which means that is highly recommended not to use that parameter as it will be removed soon.
Corresponding replacing fields will be marked with .
Multi-value
Query Parameters marked with ⓝ can be repeated and set with a different value each time in order to be set with multiple values.
Pagination
When specified in the endpoint documentation, results can be paginated specifying page and page_size Query Parameters, which will always have implicit default values.
Ordering
When specified in the endpoint documentation, results can be ordered specifying an {order_value} for order_by Query Parameter.
When order_by Query Parameter is marked with double-value symbol ②, double ordering is supported and parameter values order will be interpreted as primary ordering and secondary ordering.
| Value | Description |
|---|---|
| {order_value} | {order_value} is ordered in ascending order. |
| +{order_value} | {order_value} is ordered in ascending order. |
| -{order_value} | {order_value} is ordered in descending order. |