live_help Notes

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

settings Params

Param name Description
user_id required . Must be String

The user id or slug

sort optional . Must be one of: id, user_id, public_key, created_at, updated_at, name, fingerprint.

The sort field. Sorted by id asc by default.

Example:

To sort on gitlab users on the fields name on a descending order and fingerprint on a ascending order:

...&sort=-name,fingerprint

filter optional . Must be one of: id, user_id, public_key, created_at, updated_at, name, fingerprint.

Filtering on one or more fields

Example:

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

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

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

Select on a particular range

Example:

To range on gitlab users with the fingerprint field between min_value and max_value:

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

Rangeable fields:
  • id
  • user_id
  • public_key
  • created_at
  • updated_at
  • name
  • fingerprint
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