settings Params

Param name Description
product_id optional . Must be String

The product id or slug

campus_id optional . Must be String

The campus id or slug

sort optional . Must be one of: id, created_at, updated_at, product_id, user_id, owner_id, used.

The sort field. Sorted by id desc by default.

Example:

To sort on commands on the fields owner_id on a descending order and used on a ascending order:

...&sort=-owner_id,used

filter optional . Must be one of: id, created_at, updated_at, product_id, user_id, owner_id, used.

Filtering on one or more fields

Example:

To filter on commands with the id field matching a_value or another_value:

...&filter[id]=a_value,another_value

Filterable fields:
  • id (standard field)
  • created_at (standard field)
  • updated_at (standard field)
  • product_id (standard field)
  • user_id (standard field)
  • owner_id (standard field)
  • used (standard field)
range optional . Must be one of: id, created_at, updated_at, product_id, user_id, owner_id, used.

Select on a particular range

Example:

To range on commands with the used field between min_value and max_value:

...&range[used]=min_value,max_value

Rangeable fields:
  • id
  • created_at
  • updated_at
  • product_id
  • user_id
  • owner_id
  • used