# About the Badges API

The Badges API enables Wix users to manage badges and assign them to site members. Badges assigned to site members help them stand out from other members. Badges can also grant access to restricted pages reserved for specific members.

With the Badges API, you can:
+ Create, update, and delete badges.
+ Retrieve a site's badges or retrieve all the badges assigned to a specific member.
+ Assign and unassign badges to site members.

For an overview of badges, see [Creating and Managing Member Badges](fallback::https://support.wix.com/en/article/wix-app-creating-and-managing-member-badges).


## Before you begin
It's important to note the following before starting to code:

Member permissions can't be set with the Badges API. Wix users can [set badge permissions](fallback::https://support.wix.com/en/article/site-members-creating-and-managing-member-badges?tabs=Dashboard-0#managing-member-badges) in the Site Members area of the dashboard.


## Use cases
+ [Assign badges for the most active members](fallback::https://dev.wix.com/docs/sdk/backend-modules/members/badges/sample-flows)

## Terminology

* **Badge:** A visible label that's displayed on a site member's profile. A badge has a required name, along with an optional icon and background color.

@package_metadata:@wix/members

To use the Badges API, install the `@wix/members` package.

#### Install the package

Follow the installation instructions for your development environment.

| Development environment | Installation method |
|--|--|
| Wix sites (editor or IDE) | Use the [package manager](fallback::https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-in-the-editor). |
| Wix sites (local IDE) | Run `wix install @wix/members` using the [Wix CLI](fallback::https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-with-the-wix-cli).|
| Blocks apps | Use the same installation method as Wix sites. |
| CLI and self-hosted apps | Run `npm install @wix/members` or `yarn add @wix/members`. |
| Headless sites and apps | Run `npm install @wix/members` or `yarn add @wix/members`. |

#### Import the package

To import the package in your code:

```js
import { badges } from '@wix/members'
```

# Badges API: Sample Use Case and Flow

This article presents a possible use case and a corresponding sample flow that you can support. This can be a helpful jumping off point as you plan your implementation.

## Assign badges for the most active members

You can assign badges to members based on how many bookings they have in the past 6 months.

1. Call [List Members](fallback::https://dev.wix.com/docs/sdk/backend-modules/members/members/list-members) to retrieve a full list of a site's members and their contact IDs.
1. Call [Query Extended Bookings](fallback::https://dev.wix.com/docs/sdk/backend-modules/bookings/extended-bookings/query-extended-bookings) filtered by a `startDate` of 6 months ago and sort by `contactDetails.contactId`. Count the amount of bookings per contact and save the specific members with the amount of bookings to earn the badge.
1. Call [Create Badge](fallback::https://dev.wix.com/docs/sdk/backend-modules/members/badges/create-badge) to create a badge for members with the most bookings.
1. Call [Assign Badge](fallback::https://dev.wix.com/docs/sdk/backend-modules/members/badges/assign-badge) to assign the badge to these specific members.