/

Site Navigation

Your Account

Choose Language

Users

These endpoints provide an interface for interacting with the site's users. If a request URL does not include a {userid} parameter, then the response will be for the currently logged in user. This means that you must pass authentication information with your request. More information can be found under the Authentication Endpoints.

GET /users

List registered users.

GET /users/search/{search}

Search registered users by userid, username, unique username, or email. Userid searches will return the user with the associated userid. String searches will be ordered with exact unique username matches first, exact username matches second, exact email matches third followed by partial matches for each of these fields.

GET /users/searchnames/{search} (Deprecated)

DEPRECATED -- Please use /users/search/{search} for finding users.

Search registered users by username or unique username. Exact matches are first, followed by an alphabetical list of partial matches. Returns usernames, unique usernames, and the user's mini avatar image.

GET /users/{userid}

Returns public profile information about the user.

GET /users/sso/{sso_userid}

Returns public profile information about the user.

GET /users/email/{email}

Returns public profile information about the user.

GET /users/{userid}/badges

List badges the specified user has earned.

GET /users/{userid}/favorites/guides

List guides the user has favorited.

GET /users/{userid}/guides

Lists guides the user has contributed to.

GET /users/{userid}/completions

List guides the user has completed.

GET /user

Returns the authenticated user's information.

GET /user/badges

List badges the current user has earned.

GET /user/favorites/guides

List guides the currently logged in user has favorited.

PUT /user/favorites/guides/{guideid}

Favorite a guide

DELETE /user/favorites/guides/{guideid}

Unfavorite a guide

GET /user/guides

List guides the currently logged in user has contributed to.

GET /user/flags

List flags the currently logged in user can add and remove from guides.

GET /user/completions

List guides the current user has completed.

GET /user/media/images

List the currently logged in user's images currently in their media manager.

POST /user/media/images

Upload an image to the currently logged in user's media manager. The body of the request should be an image file of one of the following types: JPEG, JPG, GIF, PNG, BMP, TIFF, TIF. Note: Some of the sizes might be missing from the response because they are still being generated.

DELETE /user/media/images/{imageids}

Delete images from the currently logged in user's media manager. You can retrieve a list of the user's images by using GET /user/media/images. Imageids not in the currently logged in user's media manager are ignored.

POST /user/media/images/{imageid/guid}

Copies an image to the current user's media manager. This is what detach does on the website which is typically followed by saving the guide without that particular image.

GET /user/media/videos

List the currently logged in user's videos currently in their media manager.

PATCH /users/{userid}

Updates only the provided fields of an existing user.