Sign in
user-details

POST `/api/v0/main-frontend/user-details/bulk-user-details` - Get user details for a list of user IDs with course permission check Only returns user details for users who are actually enrolled in the specified course

Changed on
post/api/v0/main-frontend/user-details/bulk-user-details

Request

  • The document declares no server URL.
  • Auth: none declared

Request body

course_idstring uuid required
user_idsstring[] required

Response

Bulk user details

countrystring nullable
created_atstring date-time required
emailstring required
email_communication_consentboolean nullable
email_verified_atstring date-time nullable

When the user last proved control of the address in email. None means unproven. Cleared by a database trigger on every address change, so a value here always refers to email.

email_verified_method'emailed_code' | 'password_reset_backfill' | 'tmc_confirmed' | 'admin_asserted'

How proof of control over [UserDetail::email] was obtained. AdminAsserted is the weakest.

first_namestring nullable
last_namestring nullable
search_helperstring nullable
updated_atstring date-time required
user_idstring uuid required

Changes

  • 24ab0807c66bRevision changes
    • ○

      added the optional property / to the response with the status

    • ○

      added the optional property / to the response with the status