# check-suite

From **GitHub v3 REST API**.

A suite of checks performed on the code of a given code change

- Type: `object`

## Properties

### `after`

- Required: true
- Type: `string`
- Nullable: true
- Example: `d6fde92930d4715a2b49857d24b940956b26d2d3`

### `app`

- Required: true
- Type: `object`
- Nullable: true

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

### `before`

- Required: true
- Type: `string`
- Nullable: true
- Example: `146e867f55c26428e5f9fade55a9bbf5e95a7912`

### `check_runs_url`

- Required: true
- Type: `string`

### `conclusion`

- Required: true
- Type: `string`
- Nullable: true
- Example: `neutral`
- Allowed values: `"success"`, `"failure"`, `"neutral"`, `"cancelled"`, `"skipped"`, `"timed_out"`, `"action_required"`

### `created_at`

- Required: true
- Type: `string`
- Format: `date-time`
- Nullable: true

### `head_branch`

- Required: true
- Type: `string`
- Nullable: true
- Example: `master`

### `head_commit`

- Required: true
- Type: `object`

Simple Commit

### `head_sha`

- Required: true
- Type: `string`
- Example: `009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d`

The SHA of the head commit that is being checked.

### `id`

- Required: true
- Type: `integer`
- Example: `5`

### `latest_check_runs_count`

- Required: true
- Type: `integer`

### `node_id`

- Required: true
- Type: `string`
- Example: `MDEwOkNoZWNrU3VpdGU1`

### `pull_requests`

- Required: true
- Type: `array`
- Nullable: true

### `repository`

- Required: true
- Type: `object`

Minimal Repository

## JSON Schema

```json
{"description":"A suite of checks performed on the code of a given code change","properties":{"after":{"example":"d6fde92930d4715a2b49857d24b940956b26d2d3","nullable":true,"type":"string"},"app":{"$ref":"#/components/schemas/nullable-integration"},"before":{"example":"146e867f55c26428e5f9fade55a9bbf5e95a7912","nullable":true,"type":"string"},"check_runs_url":{"type":"string"},"conclusion":{"enum":["success","failure","neutral","cancelled","skipped","timed_out","action_required"],"example":"neutral","nullable":true,"type":"string"},"created_at":{"format":"date-time","nullable":true,"type":"string"},"head_branch":{"example":"master","nullable":true,"type":"string"},"head_commit":{"$ref":"#/components/schemas/simple-commit"},"head_sha":{"description":"The SHA of the head commit that is being checked.","example":"009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d","type":"string"},"id":{"example":5,"type":"integer"},"latest_check_runs_count":{"type":"integer"},"node_id":{"example":"MDEwOkNoZWNrU3VpdGU1","type":"string"},"pull_requests":{"items":{"$ref":"#/components/schemas/pull-request-minimal"},"nullable":true,"type":"array"},"repository":{"$ref":"#/components/schemas/minimal-repository"},"rerequestable":{"type":"boolean"},"runs_rerequestable":{"type":"boolean"},"status":{"enum":["queued","in_progress","completed"],"example":"completed","nullable":true,"type":"string"},"updated_at":{"format":"date-time","nullable":true,"type":"string"},"url":{"example":"https://api.github.com/repos/github/hello-world/check-suites/5","nullable":true,"type":"string"}},"required":["id","node_id","head_branch","status","conclusion","head_sha","url","before","after","created_at","updated_at","app","head_commit","repository","latest_check_runs_count","check_runs_url","pull_requests"],"title":"CheckSuite","type":"object"}
```