live_help Notes

chrome_reader_mode This resource is paginated by 30 items

settings Params

Param name Description
user_id optional . Must be String

The user id or slug

cursus_id optional . Must be String

The cursus id or slug

campus_id optional . Must be String

The campus id or slug

tag_id optional . Must be String

The tag id

sort optional . Must be one of: id, tag_id, user_id, created_at, updated_at, campus_id.

The sort field. Sorted by id asc by default.

Example:

To sort on tags users on the fields updated_at on a descending order and campus_id on a ascending order:

...&sort=-updated_at,campus_id

filter optional . Must be one of: id, tag_id, user_id, created_at, updated_at, campus_id, cursus_id.

Filtering on one or more fields

Example:

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

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

Filterable fields:
  • id (standard field)
  • tag_id (standard field)
  • user_id (standard field)
  • created_at (standard field)
  • updated_at (standard field)
  • campus_id (standard field)
  • cursus_id : . Can be one of: 1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 25, 26, 27, 28, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 46, 47, 48, 49
range optional . Must be one of: id, tag_id, user_id, created_at, updated_at, campus_id.

Select on a particular range

Example:

To range on tags users with the campus_id field between min_value and max_value:

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

Rangeable fields:
  • id
  • tag_id
  • user_id
  • created_at
  • updated_at
  • campus_id
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