---
# System prepended metadata

title: API Calls to Get All Badges and Award Badge

---

<div style="text-align:center"><img  src="https://www.badgewell.com/assets/Badgewell%20_Logo%20Horizontal.svg" width="250" /></div>

# API Calls to Get All Badges and Award Badge

## Get All Badges

- Base Url: https://www.badgewell.com/api/badges
- Request Type: GET request
- Response Format: JSON
- Headers x-api-key: API_SECRET_KEY_xxxx-xxxxx-xxxx-xxxx-xxxx

  Note that: you have to put your organization api key
  in `x-api-key` which you got it from badgewell.com to get all
  badges related to your organization

#### Response Status:

| Status | Description                                                                 |
| ------ | --------------------------------------------------------------------------- |
| 200    | The request was processed successfully and you should retrieve your badges. |
| 400    | There is invalid data in the data sent in the request body.                 |
| 401    | The client is not authorized to send this type of request.                  |
| 500    | There is an error on the server side.                                       |

#### Response Body:

    An array containing all badges data.

## Award Badge

- Base Url: https://www.badgewell.com/api/award
- Request Type: POST request
- Request Format: JSON
- Response Format: JSON
- Headers

  - Content-Type: application/json
  - x-api-key: API_SECRET_KEY_xxxx-xxxxx-xxxx-xxxx-xxxx

  Note that: you have to put your organization api key
  in `x-api-key` which you got it from badgewell.com to get all
  badges related to your organization

#### Query params:
| Status  | Description   |
| ------- | ------------- |
| badgeId | YOUR_BADGE_ID |

#### Request body
```JSON
{
  "awards": [
    {
      "recipientName": "WRITE_RECIPIENT_NAME_HERE",
      "email": "WRITE_RECIPIENT_VALID_EMAIL"
    }
  ]
}
```

#### Response Status:
| Status | Description                                                 |
| ------ | ----------------------------------------------------------- |
| 200    | The request was processed successfully.                     |
| 400    | There is invalid data in the data sent in the request body. |
| 401    | The client is not authorized to send this type of request.  |
| 500    | There is an error on the server side.                       |
