Method: userProfiles.get

Returns a user profile.

This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to access this user profile, if no profile exists with the requested ID, or for access errors.

HTTP request

GET https://classroom.googleapis.com/v1/userProfiles/{userId}

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
userId

string

Identifier of the profile to return. The identifier can be one of the following:

  • the numeric identifier for the user
  • the email address of the user
  • the string literal "me", indicating the requesting user

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of UserProfile.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/classroom.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly
  • https://www.googleapis.com/auth/classroom.profile.emails
  • https://www.googleapis.com/auth/classroom.profile.photos

For more information, see the OAuth 2.0 Overview.

Try it!

Send feedback about...

Classroom API
Classroom API
Need help? Visit our support page.