---
title: "Licence Tags"
description: "Pools of licence keys, by tag."
url: https://docs.filemonk.io/v2/api-reference/licence-tags/
api: "API v2 reference"
---

# Licence Tags

Pools of licence keys, by tag.

## The licence tag object

- `name` (string, nullable, required): e.g. `ebook-2026`
- `virtual` (boolean, nullable, required): e.g. `false`
- `licences` (object, required)
  - `total` (integer, nullable, required): e.g. `2`
  - `pending` (integer, nullable, required): e.g. `2`
  - `assigned` (integer, nullable, required): e.g. `0`
  - `used` (integer, nullable, required): e.g. `0`
- `digital_products` (array of anys, required)

```json
{
  "name": "ebook-2026",
  "virtual": false,
  "licences": {
    "total": 2,
    "pending": 2,
    "assigned": 0,
    "used": 0
  },
  "digital_products": []
}
```

## Endpoints

- `GET /licence_tags`: [List licence tags](https://docs.filemonk.io/v2/api-reference/licence-tags/list-licence-tags.md)
- `GET /licence_tags/{name}`: [Get a licence tag](https://docs.filemonk.io/v2/api-reference/licence-tags/get-a-licence-tag.md)
- `PATCH /licence_tags/{name}`: [Update a licence tag](https://docs.filemonk.io/v2/api-reference/licence-tags/update-a-licence-tag.md)
- `DELETE /licence_tags/{name}`: [Delete a licence tag](https://docs.filemonk.io/v2/api-reference/licence-tags/delete-a-licence-tag.md)