Skip to main content
Hypertherm - Cut with Confidence

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/employee_id/{employee_id}

Returns public profile information about the user(s).

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.

PATCH /users/{userid}

Updates only the provided fields of an existing user.

POST /users/unique_usernames

Takes an array of `unique_usernames` to create a User for each valid unique username. Returns an array of user IDs for the created users. To download a CSV with usernames and temporary passwords, use the returned user IDs with the GET /users/created_users endpoint.

GET /users/created_users

Downloads a CSV file containing usernames and temporary passwords for users created via the POST /users/unique_usernames endpoint. The CSV file will be named "Created Users {date}.csv". Important: This endpoint can only be used for users who haven't completed their account setup (password reset required).

POST /users/createByEmails

Takes an array of `emails` to create a User for each valid unique email. Returns a success message when users are created successfully.

Resources

Xnet access

Connect with us

facebook_333333_25x25.png twitter_333333_25x25.png youtube_333333_25x25.png linkedin_333333_25x25.png