---
title: "List checks"
method: GET
path: "/api/v3/checks/"
tags: ["Management API v3"]
---

# List checks

`GET /api/v3/checks/`

## Request

- Base URL: `https://watchgoose.com`
- URL: `https://watchgoose.com/api/v3/checks/`
- Auth: API key in header `X-Api-Key`

Authentication: provide a project API key in the preferred X-Api-Key header. Read-only and read-write keys are accepted for this operation.

## Query parameters

- `tag` string[]
- `slug` string

## Response `200`

Successful response.

- CheckList
  - `checks` Check[], required
    - `uuid` string, uuid
    - `unique_key` string
    - `name` string, required
    - `slug` string, required
    - `tags` string, required
    - `desc` string, required
    - `grace` integer, required: Grace period in seconds.
    - `n_pings` integer, required
    - `status` 'new' | 'up' | 'grace' | 'down' | 'paused', required
    - `started` boolean, required
    - `last_ping` string, date-time, nullable, required
    - `next_ping` string, date-time, nullable, required
    - `manual_resume` boolean, required
    - `methods` '' | 'POST', required
    - `subject` string, required
    - `subject_fail` string, required
    - `start_kw` string, required
    - `success_kw` string, required
    - `failure_kw` string, required
    - `filter_subject` boolean, required
    - `filter_body` boolean, required
    - `filter_http_body` boolean, required
    - `filter_default_fail` boolean, required
    - `badge_url` string, uri, required
    - `last_duration` integer: Last run duration in seconds.
    - `ping_url` string, uri
    - `update_url` string, uri
    - `pause_url` string, uri
    - `resume_url` string, uri
    - `channels` string: Comma-separated channel UUIDs.
    - `timeout` integer: Period in seconds for simple checks.
    - `schedule` string: Cron or OnCalendar expression.
    - `tz` string: IANA time zone used by the schedule.

## Other responses

- `401`: Missing or invalid API key.

---

[API](https://skmtc.dev/watchgoose/apis/watchgoose-apis.md) · [All operations](https://skmtc.dev/watchgoose/apis/watchgoose-apis/llms.txt) · [OpenAPI document](https://skmtc.dev/watchgoose/apis/watchgoose-apis/revisions/58049c9559bb?raw)