GET /v2/campus_users
Return all the campus users
GET /v2/users/:user_id/campus_users
Return all the campus users of the given User
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 |
sort |
optional
. Must be one of: id , user_id , campus_id , is_primary , created_at , updated_at .
The sort field. Sorted by created_at desc, id desc by default. MoreExample:To sort on campus 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 , user_id , campus_id , is_primary , created_at , updated_at .
Filtering on one or more fields MoreExample:
To filter on campus users with the
...&filter[id]=a_value,another_value Filterable fields:
|
range |
optional
. Must be one of: id , user_id , campus_id , is_primary , created_at , updated_at .
Select on a particular range MoreExample:
To range on campus users with the
...&range[updated_at]=min_value,max_value Rangeable fields:
|
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 |