---
title: retrieve-a-list-of-all-checks
product: vercel
url: /docs/rest-api/checks/retrieve-a-list-of-all-checks
type: reference
prerequisites:
  []
related:
  - /docs/rest-api
summary: Learn about retrieve-a-list-of-all-checks on Vercel.
install_vercel_plugin: npx plugins add vercel/vercel-plugin
---

# Retrieve a list of all checks

> **Deprecated**: This endpoint is deprecated and may be removed in a future version.

```http
GET /v1/deployments/{deploymentId}/checks
```

List all of the checks created for a deployment.

## Authentication

**bearerToken**: HTTP bearer

## Path parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `deploymentId` | string | Yes | The deployment to get all checks for |


## Query parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `teamId` | string | No | The Team identifier to perform the request on behalf of. |
| `slug` | string | No | The Team slug to perform the request on behalf of. |


## Responses

### 200: No description

Content-Type: `application/json`

```json
{
  "type": "object",
  "required": [
    "checks"
  ],
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "blocking",
          "createdAt",
          "id",
          "integrationId",
          "name",
          "rerequestable",
          "status",
          "updatedAt"
        ],
        "properties": {
          "completedAt": {
            "type": "number"
          },
          "conclusion": {
            "type": "string",
            "enum": [
              "canceled",
              "skipped",
              "failed",
              "neutral",
              "succeeded",
              "stale"
            ]
          },
          "createdAt": {
            "type": "number"
          },
          "detailsUrl": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "integrationId": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "output": {
            "type": "object",
            "properties": {
              "metrics": {
                "type": "object",
                "required": [
                  "CLS",
                  "FCP",
                  "LCP",
                  "TBT"
                ],
                "properties": {
                  "FCP": {
                    "type": "object",
                    "required": [
                      "source",
                      "value"
                    ],
                    "properties": {
                      "value": {
                        "type": "number",
                        "nullable": true
                      },
                      "previousValue": {
                        "type": "number"
                      },
                      "source": {
                        "type": "string",
                        "enum": [
                          "web-vitals"
                        ]
                      }
                    }
                  },
                  "LCP": {
                    "type": "object",
                    "required": [
                      "source",
                      "value"
                    ],
                    "properties": {
                      "value": {
                        "type": "number",
                        "nullable": true
                      },
                      "previousValue": {
                        "type": "number"
                      },
                      "source": {
                        "type": "string",
                        "enum": [
                          "web-vitals"
                        ]
                      }
                    }
                  },
                  "CLS": {
                    "type": "object",
                    "required": [
                      "source",
                      "value"
                    ],
                    "properties": {
                      "value": {
                        "type": "number",
                        "nullable": true
                      },
                      "previousValue": {
                        "type": "number"
                      },
                      "source": {
                        "type": "string",
                        "enum": [
                          "web-vitals"
                        ]
                      }
                    }
                  },
                  "TBT": {
                    "type": "object",
                    "required": [
                      "source",
                      "value"
                    ],
                    "properties": {
                      "value": {
                        "type": "number",
                        "nullable": true
                      },
                      "previousValue": {
                        "type": "number"
                      },
                      "source": {
                        "type": "string",
                        "enum": [
                          "web-vitals"
                        ]
                      }
                    }
                  },
                  "virtualExperienceScore": {
                    "type": "object",
                    "required": [
                      "source",
                      "value"
                    ],
                    "properties": {
                      "value": {
                        "type": "number",
                        "nullable": true
                      },
                      "previousValue": {
                        "type": "number"
                      },
                      "source": {
                        "type": "string",
                        "enum": [
                          "web-vitals"
                        ]
                      }
                    }
                  }
                }
              }
            }
          },
          "path": {
            "type": "string"
          },
          "rerequestable": {
            "type": "boolean",
            "enum": [
              false,
              true
            ]
          },
          "blocking": {
            "type": "boolean",
            "enum": [
              false,
              true
            ]
          },
          "startedAt": {
            "type": "number"
          },
          "status": {
            "type": "string",
            "enum": [
              "running",
              "completed",
              "registered"
            ]
          },
          "updatedAt": {
            "type": "number"
          }
        }
      }
    }
  }
}
```

### 400: One of the provided values in the request query is invalid.

### 401: The request is not authorized.

### 403: You do not have permission to access this resource.

### 404: The deployment was not found

---

## Related

- [checks endpoints](/docs/rest-api#checks)

- [REST API overview](/docs/rest-api)

- [OpenAPI spec](https://openapi.vercel.sh/) (machine-readable, all endpoints)

---

[View full sitemap](/docs/sitemap)