> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cocoondata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# <access-service>/api/v1/labels/{labelId}

## URL structure&#x20;

```text theme={null}
https://access-service.xy-company.com/api/v1/labels/{labelId}
```

where `{labelId}` is the ID of a label.

## Supported methods and overview&#x20;

* `GET` - used to retrieve information about an existing [label](/3.1/admin/managing-labels.md), based on the label's ID.
* `DELETE` - used to delete an exiting label.

> [!NOTE]
>
> Both of these methods take no parameters.

## Detailed description&#x20;

This API endpoint serves a number of purposes:

* Retrieves information about an existing label, using the label's ID. A label's ID can be obtained by calling the `GET` method of the [\<access-service>/api/v1/labels](/3.1/api/access-service-api-v1-labels.md) API endpoint, which retrieves a list of field information for all existing labels on the Covata Platform. \

  **Tip:** All information (except the **description** member) returned in the [response](/3.1/api/access-service-api-v1-labels-labelid.md#access-service-api-v1-labels-labelid-returns-from-a-GET-request) from a `GET` method call to this API endpoint is also returned in the [response](/3.1/api/access-service-api-v1-labels.md#access-service-api-v1-labels-returns-from-a-GET-request) from a `GET` method call to the [\<access-service>/api/v1/labels](/3.1/api/access-service-api-v1-labels.md) endpoint. Therefore, if you do not require a label's **description** when retrieving information about the label, there is no need to call the `GET` method on this API endpoint.
* Deletes an existing label from the Covata Platform. \

  **Important:** Deleting a label from the Covata Platform also removes:

  * this label from all [new](/3.1/api/access-service-api-v1-objects.md) and [existing](/3.1/api/access-service-api-v1-objects-objectid.md) [Secure Objects](/3.1/api/creating-secure-objects-and-collections.md#secure-object) it had been applied to and more importantly,
  * removes all current collaborators from these Secure Objects.

Be aware that by design and for security reasons, it is not possible to edit any aspect of a label.

## Supported roles&#x20;

This API endpoint supports the following Covata user [roles](/3.1/admin/administering-users.md#a-users-roles) (as described in the [Covata Platform Administrator's Guide](/3.1/admin.md)):

* [System administrator](/3.1/admin/administering-users.md#system-administrator-role)

The Covata Platform's resources available to one of these Covata users (above) is determined by the access token passed in the [header](/3.1/api/access-service-api-v1-labels-labelid.md#access-service-api-v1-labels-labelid-required-headers) of requests to this endpoint.

## Required headers&#x20;

The appropriate access token as the `Bearer` token:

* `Authorization: Bearer a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6`

## Returns from a GET request&#x20;

A JSON-formatted response containing the following members:

* **id** - .
* **name** - .
* **description** - .
* **priority** - .

  **Example (response from ...):**

## Returns from a DELETE request&#x20;

If the request succeeded, then an HTTP response status `200 OK` is returned.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.