Users API Reference

Using the Quizlet API you are able to view users, their sets, classes, favorites and study sessions. The amount of data returned depends on your access token - some information is only available if you are authenticated as the user you are viewing.

The following information about users is not shown publicly:

  • Their private sets
  • The list of sets they have added to favorites
  • The total count of sets created (you get the count of public sets only)
  • The total count of terms created (you get the count of terms in public sets only)

Additionally, there is some limited editing of users you can do.

This page only lists successful responses. For information about possible error responses, read the API Introduction.

Viewing Users

MethodURIDescription
GEThttps://api.quizlet.com/2.0/users/USERNAMEReturns all the user's details, and minimal information of all their sets, classes, favorites and 25 most recent study sessions.
GEThttps://api.quizlet.com/2.0/users/USERNAME/setsReturns full details about sets they created.
GEThttps://api.quizlet.com/2.0/users/USERNAME/favoritesReturns full details for all their favorite sets.
GEThttps://api.quizlet.com/2.0/users/USERNAME/classesReturns full details for all their classes
GEThttps://api.quizlet.com/2.0/users/USERNAME/studiedReturns full details for their 100 most recent study sessions.

Permissions

  • Limited information is returned when accessed using a Client ID.
  • Full details require a read-scoped access token representing the user you're viewing.

Response

The response will contain the full details of the user, and "limited information" of all their created sets, favorite sets, classes and study sessions. Limited information means that you will not see the "description" of sets and classes, the "terms" and "members in sets and classes will not be displayed, respectively.

Fetching the logged-in user

When you receive an access token in the authorization flow, you also receive a user_id field that gives you the username of the logged-in user. You can plug this username into our API to retrieve the user's information.

Expand request fields

For the users/USERNAME/favorites and users/USERNAME/sets endpoints only:

Optional Parameters

ParameterTypeDescriptionDefault
modified_sincetimestampLimits results to sets that have been modified since the specified Unix timestamp.-

Expand response fields

User object

FieldTypeDescription
username string The user's unique username.
account_type string Account type of the user. free = a normal user, plus = a Quizlet plus user.
sign_up_date timestamp The date/time of when the user first signed up to Quizlet (a UNIX timestamp).
profile_image string or null An image URL to the user's profile icon, or null if they have no image. The image can be up to 256px on its largest dimension.
statistics object Summary statistics of the user (total messages, sets created, etc).
sets array The list of sets created by the user. If not authenticated as the owner, only public sets will be listed.
favorite_sets array The list of sets the user marked as favorite. If not authenticated as the owner, this field will be missing.
studied array The list of the 25 most recent study sessions. If not authenticated as the owner, only sessions on publicly accessible sets are displayed.
classes array The list of classes the user is a member of.

Statistics object

FieldTypeDescription
study_session_count integer The total number of study sessions the user performed.
total_answer_count integer The total number of the user's answers across all sets.
public_sets_created integer The number of sets the user created that are public.
public_terms_entered integer The number of terms the user created in sets that are public.
total_sets_created integer The total number of sets the user created.
Only displayed when authenticated as the owner.
total_terms_entered integer The total number of terms the user created across all sets.
Only displayed when authenticated as the owner.

Set object

For full details of the set object, see the Sets API page.

When you are viewing the user directly (i.e. https://api.quizlet.com/2.0/users/USERNAME), the terms and description will be missing.

However, when appending /sets or /favorites, everything is returned.

Class object

For full details of the class object, see the Classes API page.

When you are viewing the user directly (i.e. https://api.quizlet.com/2.0/users/USERNAME), the list of sets and list of users for the class will be missing.

However, when appending /classes, everything is returned (the sets listed do not have the terms displayed).

Studied Session object

The terms and description of the sets studied are not displayed in the session object.

When you are viewing the studied sessions directly (i.e. https://api.quizlet.com/2.0/users/USERNAME/studied), the most recent 100 sessions are shown (instead of the just 25).

FieldTypeDescription
mode string The study mode or game type. The possible modes are learn, flashcards, test, spacerace, scatter, voicerace, vscatter, speller, bismarck, mobile_cards, mobile_learn, mobile_scatter, gravity, microscatter, review.
start_date timestamp The date/time of when the user started studying this set & mode.
finish_date timestamp The date/time of when the user finished studying. A timestamp of null means the session is still in progress.
formatted_score string The formatted score achieved on this session. Only scores for completed Speller, Scatter and Space Race modes are shown. For other modes and modes that are in progress modes, the score will be set to null.
set object The set that was studied. See the Sets API.

Example output

Output for https://api.quizlet.com/2.0/users/catchdave:

Header
HTTP/1.1 200 OK
Content-Type: application/javascript
Body
{
  "username": "catchdave",
  "account_type": "plus",
  "sign_up_date": 1300591868,
  "profile_image": "https://fbquizlet-quizletllc.netdna-ssl.com/hprofile-ak-snc4/572892_1030920097_1174590349_n.jpg",
  "statistics": {
    "study_session_count": 6,
    "total_answer_count": 15,
    "public_sets_created": 19,
    "public_terms_entered": 59,
    "total_sets_created": 19,
    "total_terms_entered": 59
  },
  "sets": [
    {
	  "id": 6009523,
	  "url": "http:\/\/quizlet.com\/6009523\/french-animals-30-flash-cards\/",
	  "title": "french animals 3.0",
	  "created_by": "catchdave",
	  "term_count": 13,
	  "created_date": 1310497102,
	  "modified_date": 1310497363,
	  "has_images": true,
	  "subjects": []
 	}
  ],
  "favorite_sets": [
    {
	  "id": 6009523,
	  "url": "http:\/\/quizlet.com\/6009523\/french-animals-30-flash-cards\/",
	  "title": "french animals 3.0",
	  "created_by": "catchdave",
	  "term_count": 13,
	  "created_date": 1310497102,
	  "modified_date": 1310497363,
	  "has_images": true,
	  "subjects": []
  	}
  ],
  "studied": [
    {
      "mode": "speller",
      "last_studied_date": 1308719871,
      "finished_date": 0,
      "score": 1674,
      "set": {
        "id": 415,
        "url": "http:\/\/quizlet.com\/415\/us-state-capitals-flash-cards\/",
        "title": "U.S. State Capitals",
        "created_by": "jalenack",
        "term_count": 50,
        "created_date": 1144296408,
        "modified_date": 1308066716,
        "has_images": false,
        "subjects": []
      }
    }
  ],
  "classes": [
    {
      "id": 103561,
      "name": "¡Old School learns español!",
      "set_count": 1,
      "user_count": 8,
      "created_date": 1310425248,
      "is_public": true
    }
  ]
}

Try it out now!

In order to test out the API you must have an API developer key.
First log in or sign up.

Editing Users

MethodURIDescription
PUThttps://api.quizlet.com/2.0/users/USERNAME/favorites/SET_IDMark a set as favorite
DELETEhttps://api.quizlet.com/2.0/users/USERNAME/favorites/SET_IDUnmark a set as favorite

Permissions

  • Requires a write_set-scoped access token authorized by the owner you are modifying.

Successful Response

Header
HTTP/1.1 204 No Content

No Body Content

Try it out now!

In order to test out the API you must have an API developer key.
First log in or sign up.