Accounts11

Alert channels6

Alert notifications1

Analytics12

Badges2

Check alerts2

Check groups11

Check results4

Check sessions7

Check status2

Checks15

Client certificates4

Dashboards5

Deployment Triggers2

Elements2

Environment variables5

Error Groups4

Heartbeats5

Incident Updates3

Incidents4

Location1

Maintenance windows12

Monitors14

Private locations8

Reporting1

Rocky AI3

Runtimes2

Secret scans1

Snippets5

Static IPs6

Status Page Incidents10

Status Page Services5

Status Pages8

Status Pages V37

Status Pages V3 Automation Rules5

Status Pages V3 Components5

Status Pages V3 Incidents11

Status Pages V3 Subscribers3

Test Session Error Groups4

Test sessions7

Triggers6

Usage8

Badges

GET /v1/badges/checks/{checkId}

Changed on Oct 31, 2026

Get check status badge. You can enable the badges feature in account settings

Request

Base URL
https://api.checklyhq.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/checklyhq/apis/checkly-public-api/docs/v1/badges/checks/:checkId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

checkIdstring required

Query parameters

style'flat' | 'plastic' | 'flat-square' | 'for-the-badge' | 'social'

theme'light' | 'dark' | 'default'

responseTimeboolean

Response

Successful

Changes

Oct 31, 2026bc90d1bfa738 Revision changes
- info
  added the optional property to the response with the status
Aug 12, 202687d29dc7b4fe Revision changes
- breaking
  removed the media type application/json for the response with the status
- info
  added the media type image/svg+xml for the response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status

Operation history