live_help Notes

chrome_reader_mode This resource is paginated by 30 items
assignment_ind This action requires a token resource owner .

settings Params

Param name Description
campus_id required . Must be String

The campus id or slug

sort optional . Must be one of: id, campus_id, tag_id, content, pinned_until, hidden_at, url, created_at, updated_at, content_html, position.

The sort field. Sorted by created_at desc, id desc by default.

Example:

To sort on broadcasts on the fields content_html on a descending order and position on a ascending order:

...&sort=-content_html,position

filter optional . Must be one of: id, campus_id, tag_id, content, pinned_until, hidden_at, url, created_at, updated_at, content_html, position, hidden.

Filtering on one or more fields

Example:

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

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

Filterable fields:
  • id (standard field)
  • campus_id (standard field)
  • tag_id (standard field)
  • content (standard field)
  • pinned_until (standard field)
  • hidden_at (standard field)
  • url (standard field)
  • created_at (standard field)
  • updated_at (standard field)
  • content_html (standard field)
  • position (standard field)
  • hidden (standard field)
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