REST API

Stars API

Generated from the Celerp 2.4.0 OpenAPI schema, 16 September 2026.

GET /stars/badge

Get Badge

The current user's supporter badge (or null) + the public founders wall URL.

Responses

StatusDescriptionBody
200Successful Responseobject

Example

curl -X GET http://localhost:8000/stars/badge \
  -H "Authorization: Bearer $TOKEN"

POST /stars/badge

Claim Badge

Store the current user's badge from a relay-issued credential.

Request body

object

Responses

StatusDescriptionBody
200Successful Responseobject
422Validation ErrorHTTPValidationError

Example

curl -X POST http://localhost:8000/stars/badge \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

DELETE /stars/badge

Delete Badge

Remove the badge and opt out of the relay founders wall (undo).

Responses

StatusDescriptionBody
200Successful Responseobject

Example

curl -X DELETE http://localhost:8000/stars/badge \
  -H "Authorization: Bearer $TOKEN"

GET /stars/badge/verify-url

Badge Verify Url

The relay verify-start URL to open in the browser. ``return_url`` is where the relay redirects back with the credential (the install's own page). Claiming a badge lists the founder on the public wall - there is no separate opt-in.

Parameters

NameInRequiredTypeDescription
return_urlqueryyesstring--

Responses

StatusDescriptionBody
200Successful Responseobject
422Validation ErrorHTTPValidationError

Example

curl -X GET http://localhost:8000/stars/badge/verify-url \
  -H "Authorization: Bearer $TOKEN"

GET /stars/cta

Star Cta

Return the relay-resolved CTA for ``medium`` (or the neutral link if the relay is unreachable), plus the install-level dismissed flag. Neutral mode when disabled.

Parameters

NameInRequiredTypeDescription
mediumquery--string--

Responses

StatusDescriptionBody
200Successful Responseobject
422Validation ErrorHTTPValidationError

Example

curl -X GET http://localhost:8000/stars/cta \
  -H "Authorization: Bearer $TOKEN"

POST /stars/dismiss

Dismiss

Dismiss the GitHub-star ask for the whole install (onboarding/milestone cards).

Responses

StatusDescriptionBody
200Successful Responseobject

Example

curl -X POST http://localhost:8000/stars/dismiss \
  -H "Authorization: Bearer $TOKEN"