GET
/
v1
/
badges
/
groups
/
{groupId}
cURL
curl --request GET \
  --url https://api.checklyhq.com/v1/badges/groups/{groupId} \
  --header 'Authorization: <api-key>'
"<string>"

​
Overview

The Get Group Status Badge endpoint generates status badges (SVG images) that display the overall health status of a check group. These badges aggregate the status of all checks within the group. Common Use Cases:
  • Service Group Status Display
  • Project Health Indicators
  • Team Dashboard Widgets
  • Multi-Check Status Summary
Response Format: SVG image
Group status badges reflect the combined health of all checks in the group. The badge will show degraded or failed status if any checks in the group are not passing.

Authorizations

​
Authorization
string
header
required

The Checkly Public API uses API keys to authenticate requests. You can get the API Key here.

Your API key is like a password: keep it secure!

Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID.

For example, set Authorization header while using cURL:

curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"

Path Parameters

​
groupId
integer
required

Query Parameters

​
style
enum<string>
default:flat
Available options:
flat,
plastic,
flat-square,
for-the-badge,
social
​
theme
enum<string>
default:default
Available options:
light,
dark,
default
​
responseTime
boolean
default:false

Response

200 - application/json

Successful

The response is of type string.