# Labels API

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

Version: 1.0

## Servers

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

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

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

## Security

### oauth2

Type: oauth2

## Download OpenAPI description

[Labels API](https://developer.hyperproof.app/_bundle/hyperproof-api/labels/labels.openapi.yaml)

## Other

### Get Labels

 - [GET /](https://developer.hyperproof.app/hyperproof-api/labels/labels.openapi/other/get-labels.md): GET /

#### Description

Retrieves details of all labels within an organization by their unique ID, including their names, descriptions, and associated objects.

### Add Label

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

#### Description

Creates a new label within an organization, defining its name, description, and associated properties for categorizing objects.

### Get Label Summaries

 - [GET /summaries](https://developer.hyperproof.app/hyperproof-api/labels/labels.openapi/other/get-label-summaries.md): GET /labels/summaries

#### Description

Retrieves summaries of all labels within an organization, including key details such as label names and permissions.

### Get Label

 - [GET /{labelId}](https://developer.hyperproof.app/hyperproof-api/labels/labels.openapi/other/get-label.md): GET /{labelId}

#### Description

Retrieves details of a specific label by its unique ID, including its name, description, and associated objects.

### Update Label

 - [PATCH /{labelId}](https://developer.hyperproof.app/hyperproof-api/labels/labels.openapi/other/update-label.md): Updates an existing label with new values.

### Add Label Proof

 - [POST /{labelId}/proof](https://developer.hyperproof.app/hyperproof-api/labels/labels.openapi/other/add-label-proof.md): POST /{labelId}/proof

#### Description

Adds a new proof item to a specified label, associating the evidence with that label for easier organization and tracking.

This endpoint allows the uploading of multi part form data (files) to be linked as new proof on a label.

The response from this call will return the id of the new proof.