live_help Notes

chrome_reader_mode This resource is paginated by 30 items

settings Params

Param name Description
cursus_id optional . Must be String

The cursus id or slug

sort optional . Must be one of: id, name, created_at, updated_at, slug.

The sort field. Sorted by name asc, id desc by default.

Example:

To sort on skills on the fields updated_at on a descending order and slug on a ascending order:

...&sort=-updated_at,slug

filter optional . Must be one of: id, name, created_at, updated_at, slug.

Filtering on one or more fields

Example:

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

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

Filterable fields:
  • id (standard field)
  • name (standard field)
  • created_at (standard field)
  • updated_at (standard field)
  • slug (standard field)
range optional . Must be one of: id, name, created_at, updated_at, slug.

Select on a particular range

Example:

To range on skills with the slug field between min_value and max_value:

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

Rangeable fields:
  • id
  • name
  • created_at
  • updated_at
  • slug
page optional . Must be a Hash

The pagination params, as a hash

page[number] optional . Must be Fixnum

The current page

page[size] optional . Must be Fixnum

The number of items per page, defaults to 30, maximum 100