Fetch profiles from the CSIAPPS registration API

Retrieves all profiles accessible to the authenticated user, with optional filtering. Automatically paginates — all matching profiles are returned in a single list regardless of how many pages the API uses.

Usage

fetch_profiles(token = NULL, filters = list(), sandbox = is_sandbox_mode())

Arguments

token

Character. Authentication token. When not supplied, it is resolved for the current Shiny session (the token stored by server_wrapper()) and otherwise falls back to the CSIAPPS_ACCESS_TOKEN environment variable.

filters

Named list of query parameters for filtering. Common filters include sport_org_id (integer, filter by organisation) and sport (filter by sport). See the CSIAPPS Swagger docs for all available parameters.

sandbox

Logical. When TRUE (the default in development), no network call is made and profiles are read from the local dummy registry (those created with create_profile()); only the sport_org_id filter is applied, other filters are ignored. Set to FALSE to fetch real profiles from the API. Defaults to is_sandbox_mode().

Value

A list of profile objects. Each element contains a person sub-list (first_name, last_name, dob, email, ...), a sport sub-list (id, name), and top-level fields such as status and current_nomination. See the CSIAPPS Swagger docs for the full schema.

See also

fetch_profile() to retrieve a single profile by ID, fetch_org_options() to list available organisations, set_institute() to configure the target institute.

Examples

if (FALSE) { # \dontrun{
set_institute("csiontario")

# All profiles your token can see
profiles <- fetch_profiles(sandbox = FALSE)

# Profiles for a specific organisation
profiles <- fetch_profiles(filters = list(sport_org_id = 42L), sandbox = FALSE)

# Build a display data frame
profile_df <- do.call(rbind, lapply(profiles, function(p) {
  data.frame(
    id         = p$id,
    first_name = p$person$first_name %||% NA_character_,
    last_name  = p$person$last_name  %||% NA_character_,
    email      = p$person$email      %||% NA_character_
  )
}))
} # }