GET /users/filtered/
Description
Lists fieldnames specified in fields parameter for list of users defined by user_filter parameter.
Endpoints
GET /users/filtered/?fields=&user_filter=
GET /users/filtered/page{#}/?fields=&user_filter=
GET /users/filtered/count/?user_filter=
Parameters
fields : (string) comma-delimited-fieldnames formatted as described below
user_filter : (user-search-phrase) as described here
Notes
- The
comma-delimited-fieldnames string can contain one or more of the following values
id, username, first_name, last_name, email, middle_init, date_start, date_expire, company, address, city, state, zip, phone, custom1, custom2, custom3, custom4, custom5, custom6, custom7, custom8, custom9, custom10, custom11, custom12, custom13, custom14, custom 15, localization, role, manager_id, usergroups, courses, iltclasses, certifications, learningpaths, badges, organizations, sysvars, sso
- To use multiple values, separate each fieldname with a comma like this:
username,email,courses
- The first fieldname will be used to sort the delivered results
role valid values are learner and managersysvars will return all system/global variables including custom fields beyond custom1 > custom15 which can be specified individuallysso will return a single-sign-on link that will be valid for 1 hour- These endpoints return paginated results, therefore having
/page{#}/ and /count/ endpoint variants to read and control the results delivered
- The
/count/ endpoint does require the user_filter parameter to get the proper count for filtered results
Returns comma-delimited-fields specified in the fields parameter, or id and username if the comma-delimited-fields parameter is not set
[
{
"id": "1",
"username": "ad345345",
"first_name": "Bob",
"last_name": "Smith",
},
{
"id": "2",
"username": "gu345345",
"first_name": "Sam",
"last_name": "Jones",
}
]
Description
Lists fieldnames specified in fields parameter for list of users defined by user_filter parameter.
Endpoints
GET /users/filtered/?fields=&user_filter=GET /users/filtered/page{#}/?fields=&user_filter=GET /users/filtered/count/?user_filter=
Parameters
fields : (string) comma-delimited-fieldnames formatted as described below
user_filter : (user-search-phrase) as described here
Notes
- The
comma-delimited-fieldnamesstring can contain one or more of the following valuesid, username, first_name, last_name, email, middle_init, date_start, date_expire, company, address, city, state, zip, phone, custom1, custom2, custom3, custom4, custom5, custom6, custom7, custom8, custom9, custom10, custom11, custom12, custom13, custom14, custom 15, localization, role, manager_id, usergroups, courses, iltclasses, certifications, learningpaths, badges, organizations, sysvars, sso - To use multiple values, separate each fieldname with a comma like this:
username,email,courses - The first fieldname will be used to sort the delivered results
rolevalid values arelearnerandmanagersysvarswill return all system/global variables including custom fields beyondcustom1>custom15which can be specified individuallyssowill return a single-sign-on link that will be valid for 1 hour- These endpoints return paginated results, therefore having
/page{#}/and/count/endpoint variants to read and control the results delivered - The
/count/endpoint does require theuser_filterparameter to get the proper count for filtered results
Returns comma-delimited-fields specified in the fields parameter, or id and username if the comma-delimited-fields parameter is not set
[ { "id": "1", "username": "ad345345", "first_name": "Bob", "last_name": "Smith", }, { "id": "2", "username": "gu345345", "first_name": "Sam", "last_name": "Jones", }]