List the badges your group can award
curl --request GET \
--url https://api.scoutworks.app/api/v1/badge-catalogue \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.scoutworks.app/api/v1/badge-catalogue"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.scoutworks.app/api/v1/badge-catalogue', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": [
{
"id": "<string>",
"key": "<string>",
"name": "<string>",
"category": "challenge_awards",
"type": "activity",
"sections": [
"squirrels"
],
"stage": 0,
"series": "<string>",
"requirements": [
{
"id": "<string>",
"description": "<string>"
}
]
}
],
"nextCursor": "<string>"
}{
"error": {
"code": "invalid_api_key",
"message": "<string>"
},
"errorRef": "<string>",
"retryAfter": 0
}{
"error": {
"code": "invalid_api_key",
"message": "<string>"
},
"errorRef": "<string>",
"retryAfter": 0
}{
"error": {
"code": "invalid_api_key",
"message": "<string>"
},
"errorRef": "<string>",
"retryAfter": 0
}{
"error": {
"code": "invalid_api_key",
"message": "<string>"
},
"errorRef": "<string>",
"retryAfter": 0
}{
"error": {
"code": "invalid_api_key",
"message": "<string>"
},
"errorRef": "<string>",
"retryAfter": 0
}Badges
List the badges your group can award
Every built-in badge and your group’s own custom badges, with their section, stage and requirements. Each requirement has a stable id, the same one a badge record’s requirements uses. A built-in badge’s key (for example badge_001) and its requirement ids do not change between releases.
GET
/
badge-catalogue
List the badges your group can award
curl --request GET \
--url https://api.scoutworks.app/api/v1/badge-catalogue \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.scoutworks.app/api/v1/badge-catalogue"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.scoutworks.app/api/v1/badge-catalogue', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": [
{
"id": "<string>",
"key": "<string>",
"name": "<string>",
"category": "challenge_awards",
"type": "activity",
"sections": [
"squirrels"
],
"stage": 0,
"series": "<string>",
"requirements": [
{
"id": "<string>",
"description": "<string>"
}
]
}
],
"nextCursor": "<string>"
}{
"error": {
"code": "invalid_api_key",
"message": "<string>"
},
"errorRef": "<string>",
"retryAfter": 0
}{
"error": {
"code": "invalid_api_key",
"message": "<string>"
},
"errorRef": "<string>",
"retryAfter": 0
}{
"error": {
"code": "invalid_api_key",
"message": "<string>"
},
"errorRef": "<string>",
"retryAfter": 0
}{
"error": {
"code": "invalid_api_key",
"message": "<string>"
},
"errorRef": "<string>",
"retryAfter": 0
}{
"error": {
"code": "invalid_api_key",
"message": "<string>"
},
"errorRef": "<string>",
"retryAfter": 0
}Authorizations
A group API key, sent as Authorization: Bearer sw_live_…. Keys from staging and the demo start sw_test_ instead. A group admin creates keys in Settings → Integrations → API keys.
Query Parameters
Opaque. Pass the nextCursor of the previous page, with the same filters, to get the next one. Do not build or parse it.
Required string length:
1 - 512Page size, 1 to 200. Defaults to 50.
Required range:
1 <= x <= 200