List badges

GET 
/admin/badges.json

List badges

Responses

200

success response

application/json

Schema

Schema

badges object[]required
Array [
id integerrequired
name stringrequired
description stringrequired
grant_count integerrequired
allow_title booleanrequired
multiple_grant booleanrequired
icon stringrequired
image_url stringnullrequired
listable booleanrequired
enabled booleanrequired
badge_grouping_id integerrequired
system booleanrequired
long_description stringrequired
slug stringrequired
manually_grantable booleanrequired
query stringnullrequired
trigger integernullrequired
target_posts booleanrequired
auto_revoke booleanrequired
show_posts booleanrequired
i18n_name stringnullrequired
badge_type_id integerrequired
]
badge_types object[]required
Array [
id integerrequired
name stringrequired
sort_order integerrequired
]
badge_groupings object[]required
Array [
id integerrequired
name stringrequired
description stringnullrequired
position integerrequired
system booleanrequired
]
admin_badges objectrequired
protected_system_fields undefined[]required
triggers objectrequired
user_change integerrequired
none integerrequired
post_revision integerrequired
trust_level_change integerrequired
post_action integerrequired
badge_ids undefined[]required
badge_grouping_ids undefined[]required
badge_type_ids undefined[]required

Example (from schema)

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

Loading...