ForumBadgesApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| createForumBadge | POST /community/badges | Create a new badge (Admin only) |
| listAllForumBadges | GET /community/badges | List all available badges |
| listForumProfileBadges | GET /community/badges/profile/{profile_id} | List badges for a specific profile ID |
createForumBadge
BadgeResponse createForumBadge(CreateBadgeRequest)
Create a new badge (Admin only)
Creates a new achievement badge for the community. Admins define badge name, description, icon, and points threshold to establish new recognition milestones for member contributions.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| CreateBadgeRequest | CreateBadgeRequest | Badge details including name, description, icon URL, and points threshold |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
listAllForumBadges
PaginatedResponse_BadgeResponse listAllForumBadges(page, per_page)
List all available badges
Retrieves the complete catalog of achievement badges available in the community. Public endpoint that shows all badges members can earn through participation and contributions.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page | Integer | Page number (default: 1) | [optional] [default to null] |
| per_page | Integer | Items per page (default: 20) | [optional] [default to null] |
Return type
PaginatedResponse_BadgeResponse
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listForumProfileBadges
PaginatedResponse_ProfileBadgeAwardResponse listForumProfileBadges(profile_id, page, per_page)
List badges for a specific profile ID
Retrieves all badges earned by a community member, including award timestamps. Public endpoint that displays a member’s achievements and recognition on their profile.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| profile_id | Long | ID of the forum profile to retrieve badges for | [default to null] |
| page | Integer | Page number (default: 1) | [optional] [default to null] |
| per_page | Integer | Items per page (default: 20) | [optional] [default to null] |
Return type
PaginatedResponse_ProfileBadgeAwardResponse
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8