Skip to content
Docs

Retrieve a list of all checks

GEThttps://api.vercel.com/v1/deployments/{deploymentId}/checks
List all of the checks created for a deployment.

This endpoint is deprecated

https://api.vercel.com/v1/deployments/{deploymentId}/checks
const response = await fetch('https://api.vercel.com/v1/deployments/deploymentId/checks?teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});


const data = await response.json();
console.log(data);
Response
{
  "checks": [
    {
      "completedAt": "123",
      "conclusion": "canceled",
      "createdAt": "123",
      "detailsUrl": "https://example.com",
      "id": "icfg_1234567890",
      "integrationId": "example_id",
      "name": "Example Name",
      "output": {
        "metrics": {
          "FCP": {
            "value": "123",
            "previousValue": "123",
            "source": "web-vitals"
          },
          "LCP": {
            "value": "123",
            "previousValue": "123",
            "source": "web-vitals"
          },
          "CLS": {
            "value": "123",
            "previousValue": "123",
            "source": "web-vitals"
          },
          "TBT": {
            "value": "123",
            "previousValue": "123",
            "source": "web-vitals"
          },
          "virtualExperienceScore": {
            "value": "123",
            "previousValue": "123",
            "source": "web-vitals"
          }
        }
      },
      "path": "string",
      "rerequestable": "false",
      "blocking": "false",
      "startedAt": "123",
      "status": "completed",
      "updatedAt": "123"
    }
  ]
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

deploymentIdstringRequired
The deployment to get all checks for

Query parameters

teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.

Response

200Success
checksarrayRequired

Errors

400One of the provided values in the request query is invalid.
401The request is not authorized.
403You do not have permission to access this resource.
404The deployment was not found
410Error