Skip to content
Docs

List all checks for a project

GEThttps://api.vercel.com/v2/projects/{projectIdOrName}/checks
List all checks for a project, optionally filtered by target.
https://api.vercel.com/v2/projects/{projectIdOrName}/checks
const response = await fetch('https://api.vercel.com/v2/projects/projectIdOrName/checks?blocks=string&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": [
    {
      "id": "icfg_1234567890",
      "name": "Example Name",
      "ownerId": "example_id",
      "projectId": "example_id",
      "isRerequestable": "false",
      "requires": "build-ready",
      "source": {
        "kind": "integration",
        "integrationId": "example_id",
        "integrationConfigurationId": "example_id",
        "resourceId": "example_id",
        "externalResourceId": "example_id"
      },
      "blocks": "build-start",
      "targets": [],
      "sourceKind": "git-provider",
      "sourceIntegrationConfigurationId": "example_id",
      "timeout": "123",
      "createdAt": "123",
      "updatedAt": "123",
      "deletedAt": "123"
    }
  ]
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

projectIdOrNamestringRequired

Query parameters

blocksstringOptional
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.
410Error
500Error