Stars API
Supporter badge and Celerp community recognition API for badge verification, display, opt-out, and prompts.
Generated from the Celerp 2.5.0 OpenAPI schema, 21 September 2026.
GET /stars/badge
Get Supporter Badge
Return the current user's Celerp supporter badge, if any, together with the public community recognition link.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the requested supporter badge result. | object |
Example
curl -X GET http://localhost:8000/stars/badge \
-H "Authorization: Bearer $TOKEN"POST /stars/badge
Claim Supporter Badge
Claim and save the current user's Celerp supporter badge.
Request body
object
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the saved badge. | object |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X POST http://localhost:8000/stars/badge \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'DELETE /stars/badge
Remove Supporter Badge
Remove the current user's supporter badge and opt out of public badge display.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns `removed: true` once the badge is removed. | object |
Example
curl -X DELETE http://localhost:8000/stars/badge \
-H "Authorization: Bearer $TOKEN"GET /stars/badge/verify-url
Get Supporter Badge Verification URL
Return the verification URL used to confirm eligibility for a Celerp supporter badge.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
return_url | query | yes | string | URL to return to after completing the external authorization flow. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the requested supporter badge verification URL result. | object |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X GET http://localhost:8000/stars/badge/verify-url \
-H "Authorization: Bearer $TOKEN"GET /stars/cta
Get Supporter Call to Action
Return the supporter call-to-action content for the requested placement.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
medium | query | -- | string | Placement or medium for which supporter call-to-action content is requested. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the requested supporter call to action result. | object |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X GET http://localhost:8000/stars/cta \
-H "Authorization: Bearer $TOKEN"POST /stars/dismiss
Dismiss Supporter Prompt
Dismiss the supporter prompt for this Celerp installation.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns `dismissed: true`. | object |
Example
curl -X POST http://localhost:8000/stars/dismiss \
-H "Authorization: Bearer $TOKEN"