live_help Notes

assignment This action requires one of theses roles: Companies manager
chrome_reader_mode This resource is paginated by 30 items

settings Params

Param name Description
offer_id optional . Must be String

The offer id or slug

user_id optional . Must be String

The user id or slug

sort optional . Must be one of: id, offer_id, user_id, validated_at, created_at, updated_at.

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

Example:

To sort on offers users on the fields created_at on a descending order and updated_at on a ascending order:

...&sort=-created_at,updated_at

filter optional . Must be one of: id, offer_id, user_id, validated_at, created_at, updated_at, validated.

Filtering on one or more fields

Example:

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

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

Filterable fields:
  • id (standard field)
  • offer_id (standard field)
  • user_id (standard field)
  • validated_at (standard field)
  • created_at (standard field)
  • updated_at (standard field)
  • validated (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