Skip to main content
Use the API to Make Flairs

How to use the Stack Overflow for Teams Enterprise API to manage flairs.

Joel Bradley avatar
Written by Joel Bradley
Updated over a month ago

Tags | API | Flairs |

Applies to: Enterprise

ADMIN PRIVILEGES REQUIRED

This documentation is for Stack Overflow for Teams Enterprise. Free, Basic, and Business users can access their documentation here. Find your plan.


Overview

"Flair" is a visual indication of a user's achievements on a site, usually in the form of an icon, badge, or color. On Stack Overflow, we use badges and reputation scores as flair to encourage and reward user engagement.

API v3

You can use Stack Overflow for Teams API v3 to get reputation data for your users. Reputation is a good indicator of a user's overall engagement on your site. To access user data, including reputation, use the following API requests.

/users/me
Retrieve data for the logged-in user.

/users
Retrieve data for all users on the site.

/users/[userId]
Retrieve data on an individual user (specified by user ID).

The SOE interactive API documentation makes it easy to test out API v3 requests. You can access this API "sandbox" by going to https://[your_site]/api/v3. Learn more in the Stack Overflow for Teams API v3 article. Below is an example of an API v3 interactive documentation user data request.

The interactive documentation system shows the raw API request URL and any returned user data.

You can copy the request URL to jump-start the development of your own custom API integrations.

NOTE: API v3 does not currently provide badge data for users. This will be added in a future update.

Security and Privacy

As with any API application, SOE API requests may return information you don't want made available on your site (for example: user ID or profile link). To avoid any breach of security or privacy, practice caution when deciding what data to include with your flair integration.

Did this answer your question?