# Issues API

Provides access to the issues that are part of a Hyperproof organization.

Version: 1.0

## Servers

Hyperproof US
```
https://api.hyperproof.app/v1/issues
```

Hyperproof Gov
```
https://api.hyperproofgov.app/v1/issues
```

Hyperproof EU
```
https://api.hyperproof.eu/v1/issues
```

## Security

### oauth2

Type: oauth2

## Download OpenAPI description

[Issues API](https://developer.hyperproof.app/_bundle/Hyperproof%20API/Issues/issues.openapi.yaml)

## Other

### Add Issue

 - [POST /](https://developer.hyperproof.app/hyperproof-api/issues/issues.openapi/other/add-issue.md): POST /

#### Description

Creates a new issue within an organization, capturing details such as title, description, severity, and associated objects.

### Get Issues Filtered

 - [PUT /filter](https://developer.hyperproof.app/hyperproof-api/issues/issues.openapi/other/get-issues-filtered.md): PUT /

#### Description

Retrieves a collection of issues that match the specified filter criteria, such as status, priority, or assigned user.

### Get Issue

 - [GET /{issueId}](https://developer.hyperproof.app/hyperproof-api/issues/issues.openapi/other/get-issue.md): GET /{issueId}

#### Description

Retrieves details of a specific issue by its unique ID, including its title, description, status, and associated metadata.

### Update Issue

 - [PATCH /{issueId}](https://developer.hyperproof.app/hyperproof-api/issues/issues.openapi/other/update-issue.md): PATCH /{issueId}

#### Description

Updates an existing issue with new values, allowing changes to fields such as title, description, status, or assigned user.

### Add Issue Proof

 - [POST /{issueId}/proof](https://developer.hyperproof.app/hyperproof-api/issues/issues.openapi/other/add-issue-proof.md): POST /{issueId}/proof

#### Description

Adds proof to a specified issue, uploading evidence files or links and associating them with the issue for verification and auditing purposes.

### Get Issue Proof Metadata

 - [GET /{issueId}/proof](https://developer.hyperproof.app/hyperproof-api/issues/issues.openapi/other/get-issue-proof-meta.md): GET /{issueId}/proof

#### Description

Retrieves all proof items linked to a specified issue, including file details, upload metadata, and source information.

### Get Issue Comments

 - [GET /{issueId}/comments](https://developer.hyperproof.app/hyperproof-api/issues/issues.openapi/other/get-issue-comments.md): GET /{issueId}/comments

#### Description

Retrieves all comments from an issue’s Activity Feed, including details such as author, timestamp, and message content.

### Add Issue Comment

 - [POST /{issueId}/comments](https://developer.hyperproof.app/hyperproof-api/issues/issues.openapi/paths/~1%7Bissueid%7D~1comments/post.md): POST /{issueId}/comments

#### Description

Adds a new comment to a specified issue via the issue's Activity Feed, recording the comment’s content, author, and timestamp.

### Update Issue Comment

 - [PATCH /{issueId}/comments/{commentId}](https://developer.hyperproof.app/hyperproof-api/issues/issues.openapi/paths/~1%7Bissueid%7D~1comments~1%7Bcommentid%7D/patch.md): PATCH /{issueId}/comments/{commentId}

#### Description

Updates the content of an existing comment linked to an issue, modifying its text or related metadata.

### Delete Issue Comment

 - [DELETE /{issueId}/comments/{commentId}](https://developer.hyperproof.app/hyperproof-api/issues/issues.openapi/paths/~1%7Bissueid%7D~1comments~1%7Bcommentid%7D/delete.md): DEL /{issueId}/comments/{commentId}

#### Description

Deletes a specified comment from an issue, removing its content and associated metadata from the issue’s Activity Feed.