GET /users/{user-id}/
Description
Lists fieldnames specified in fields parameter for user-id.
Endpoints
GET /users/{user-id}/?fields=GET /users/{user-id}/page{#}/?fields=GET /users/{user-id}/count/
Parameters
fields : (string) comma-delimited-fieldnames formatted as described below
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 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
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", "email": "example@oururl.com", "middle_init": "J", "date_start": "", "date_expire": "", "company": "", "address": "135 Cherry Tree Lane", "city": "Cherry Hill", "state": "NJ", "zip": "12345", "phone": "", "custom1": "Blue", "custom2": "8565557831", "custom3": "", "custom4": "", "custom5": "", "custom6": "", "custom7": "", "custom8": "", "custom9": "", "custom10": "", "custom11": "", "custom12": "", "custom13": "", "custom14": "", "custom15": "", "localization": "", "role": "manager", "manager_id": "266", "usergroups": [ "Supervisors Group" ], "courses": [ { "id": 1171, "name": "Management 101" }, { "id": 1074, "name": "Management 201" } ], "sso": "https://my.lmssite.com/sso.php?r=V1ZkU2RHRlhOVGhNVXpFNFdWZFNkR0ZYTlRoTVV6RTRVVmMxdfgg7GH7g&", "iltclasses": [ { "program": { "id": "15", "name": "Advanced Spanish" }, "session": { "id": "15", "name": "Fall Session 2023" } }, { "program": { "id": "38", "name": "Supvervisors 101" }, "session": { "id": "66", "name": "Winter Session 2023" } }, ] "certifications": [ { "id": "165", "number": "58736397d6s", "program-id": "27", "program-name": "On the Job (3rd Party)" }, { "id": "164", "number": "23458762348956", "program-id": "28", "program-name": "Email Security" }, { ], "learningpaths": [ { "id": "9", "name": "New Hire" }, { "id": "1", "name": "Supervisors" }, ] "organizations": [ { "org-id": "1", "org-name": "Office1", "branch-id": "1", "branch-name": "New Jersey" }, { "org-id": "5", "org-name": "Office2", "branch-id": "10", "branch-name": "Delaware" } ], "axis.course-fail": "38", "axis.course-pass": "5", "axis.course-perfectscore": "1", "axis.forum-post": "3", "axis.forum-topic_add": "2", "axis.game-points": "38", "axis.message-sent": "2", "axis.userconnect-comment": "1", "axis.userconnect-like": "2", "axis.userconnect-post": "14", "c101-login": "114", }]