List licence tags

GET/licence_tags

Costs 1 rate-limit point · Rate limits

The licence tags the shop's keys and licence-key files use, as the Licence tags page lists them: key counts by status and the digital products each tag supplies. No Tag (uploaded keys without a tag) and Autogenerated are built-in groups, marked virtual. search matches the name.

Also searched aslist licence tagswhich tag is running out of keyskeys left per taglicence key pools

Query parameters

pageinteger
1-based page number.
Default 1
per_pageinteger
Rows per page, max 200.
Default 50
searchstring

Returns

dataarray of objects
Show 4 child attributesHide child attributes
- namestring, nullable
  Example: ebook-2026
- virtualboolean, nullable
  Example: false
- licencesobject
  Show 4 child attributesHide child attributes
  - totalinteger, nullable
    Example: 2
  - pendinginteger, nullable
    Example: 2
  - assignedinteger, nullable
    Example: 0
  - usedinteger, nullable
    Example: 0
- digital_productsarray of anys
metaobject
Paging of a list (page, per_page query params).
Show 4 child attributesHide child attributes
- total_countinteger
  Rows across all pages.
- pageinteger
  1-based page number.
- per_pageinteger
  Rows per page, max 200.
- total_pagesinteger
  Example: 1
totalsobject
Show 4 child attributesHide child attributes
- totalinteger, nullable
  Example: 8
- pendinginteger, nullable
  Example: 6
- assignedinteger, nullable
  Example: 1
- usedinteger, nullable
  Example: 1

Errors

401

Missing or invalid API key.

422

The request failed validation, or sent a key the action does not take (code: "unknown_parameters" with unknown and accepted). Nothing was saved.

429

Rate limited. Cost-weighted per API key, shared with API v1: a read costs 1 point, a write 2, 40 points per fixed 60-second window. Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix time the window ends); a 429 adds Retry-After (seconds), retry_after, retryable: true and a next_step in the body. A 429 did nothing: wait retry_after seconds, then send the same request again. The budget is per key, so every tool or script using the key shares it; prefer one list call with per_page over many single reads.

Every error has the same shape: see Errors.

GET/licence_tags

curl "https://app.filemonk.io/api/v2/external/licence_tags" \
  -H "X-Auth-Token: $FILEMONK_API_KEY"

const res = await fetch("https://app.filemonk.io/api/v2/external/licence_tags", {
  headers: {
    "X-Auth-Token": process.env.FILEMONK_API_KEY,
  },
});
const data = await res.json();

import os
import requests

res = requests.get(
    "https://app.filemonk.io/api/v2/external/licence_tags",
    headers={"X-Auth-Token": os.environ["FILEMONK_API_KEY"]},
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.filemonk.io/api/v2/external/licence_tags")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["FILEMONK_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

Response

{
  "data": [
    {
      "name": "ebook-2026",
      "virtual": false,
      "licences": {
        "total": 2,
        "pending": 2,
        "assigned": 0,
        "used": 0
      },
      "digital_products": []
    }
  ],
  "meta": {
    "total_count": 6,
    "page": 1,
    "per_page": 50,
    "total_pages": 1
  },
  "totals": {
    "total": 8,
    "pending": 6,
    "assigned": 1,
    "used": 1
  }
}

{
  "errors": [
    "Invalid API key"
  ]
}

{
  "errors": [
    "access.download_limit_count must be an integer of at least 0"
  ],
  "field_errors": {
    "access.download_limit_count": [
      "must be an integer of at least 0"
    ]
  }
}

{
  "errors": [
    "You have exceeded the rate limit of 40 points per 60 seconds. Read requests cost 1 point(s) and write requests cost 2 point(s). Please retry after 12 second(s)."
  ],
  "code": "rate_limited",
  "retry_after": 12,
  "error": "Rate limit exceeded",
  "message": "You have exceeded the rate limit of 40 points per 60 seconds. Read requests cost 1 point(s) and write requests cost 2 point(s). Please retry after 12 second(s)."
}