Badges

List badges

GET

https://discourse.example.com/admin/badges.json

List badges

curl -X GET 'https://discourse.example.com/admin/badges.json'

const response = await fetch('https://discourse.example.com/admin/badges.json', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://discourse.example.com/admin/badges.json')
print(response.text)

200

{
  "badges": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "grant_count": 0,
      "allow_title": true,
      "multiple_grant": true,
      "icon": "string",
      "image_url": "string",
      "listable": true,
      "enabled": true,
      "badge_grouping_id": 0,
      "system": true,
      "long_description": "string",
      "slug": "string",
      "manually_grantable": true,
      "query": "string",
      "trigger": 0,
      "target_posts": true,
      "auto_revoke": true,
      "show_posts": true,
      "i18n_name": "string",
      "image_upload_id": 0,
      "badge_type_id": 0,
      "show_in_post_header": true
    }
  ],
  "badge_types": [
    {
      "id": 0,
      "name": "string",
      "sort_order": 0
    }
  ],
  "badge_groupings": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "position": 0,
      "system": true
    }
  ],
  "admin_badges": {
    "protected_system_fields": [],
    "triggers": {
      "user_change": 0,
      "none": 0,
      "post_revision": 0,
      "trust_level_change": 0,
      "post_action": 0
    },
    "badge_ids": [],
    "badge_grouping_ids": [],
    "badge_type_ids": []
  }
}

Response

200OKany

success response

Response fields application/json

badgesArray<object>required

Show child attributes

idintegerrequired

namestringrequired

descriptionstringrequired

grant_countintegerrequired

allow_titlebooleanrequired

multiple_grantbooleanrequired

iconstringrequired

image_urlstring | nullrequired

listablebooleanrequired

enabledbooleanrequired

badge_grouping_idintegerrequired

systembooleanrequired

long_descriptionstringrequired

slugstringrequired

manually_grantablebooleanrequired

querystring | nullrequired

triggerinteger | nullrequired

target_postsbooleanrequired

auto_revokebooleanrequired

show_postsbooleanrequired

i18n_namestring | null

image_upload_idinteger | nullrequired

badge_type_idintegerrequired

show_in_post_headerbooleanrequired

badge_typesArray<object>required

Show child attributes

idintegerrequired

namestringrequired

sort_orderintegerrequired

badge_groupingsArray<object>required

Show child attributes

idintegerrequired

namestringrequired

descriptionstring | nullrequired

positionintegerrequired

systembooleanrequired

admin_badgesobjectrequired

Show child attributes

protected_system_fieldsArray<any>required

triggersobjectrequired

Show child attributes

user_changeintegerrequired

noneintegerrequired

post_revisionintegerrequired

trust_level_changeintegerrequired

post_actionintegerrequired

badge_idsArray<any>required

badge_grouping_idsArray<any>required

badge_type_idsArray<any>required

Docs by Sourcey