get_users: Get All Users

In skilljaR: Connect to Your 'Skilljar' Data

Get All Users

Description

Returns a data.frame with all users from a particular domain. If you have many users and do not want to return them all at once, you may request fewer users to save time while doing development. The API returns up 10,000 users at a time– if you request more than 10,000, it will return in full page increments (a multiple of 10,000).

Usage

get_users(users_desired = 1e+08, api_token)

Arguments

users_desired	Number of user records to return
api_token	Your personalized token provided by 'Skilljar'

Details

Utilizing the API requires a token. This must be obtained by logging in at dashboard.skilljar.com and going to Organization -> API Credentials. There are different strategies for storing api tokens securely. It is an unnecessary risk to store the token in the script!

Value

A data frame with users and user data

See Also

See https://api.skilljar.com/docs/ for documentation on the 'Skilljar' API.

Examples

## Not run: 
# Retrieve 1000 users
my_users <- get_users(users_desired = 1000,
api_token = "my-token")

## End(Not run)

skilljaR documentation built on Sept. 19, 2023, 5:08 p.m.