List licences

GET/licences

Costs 1 rate-limit point · Rate limits

List licence keys newest first, paginated (page, per_page up to 200). key_status is pending, assigned or used; source is uploaded or auto_generated; tag narrows to one licence tag (No Tag and Autogenerated are the two built-in groups); search matches part of the key.

Also searched aslist licence keysunused licence keyshow many keys are lefthow many licence keys do I havelicence keys leftkeys for a tagfind a key

Query parameters

key_statusstring
One of pendingassignedused
sourcestring
One of uploadedauto_generated
pageinteger
1-based page number.
Default 1
per_pageinteger
Rows per page, max 200.
Default 50
tagstring
searchstring

Returns

dataarray of objects
Show 9 child attributesHide child attributes
- idstring, nullable
  Example: bcc87d33-c87e-4f39-9cd2-e43250ebc1ed
- keystring, nullable
  Example: ABCD-EFGH-0005
- sourcestring, nullable
  Example: uploaded
- statusstring, nullable
  Example: pending
- tagsarray of strings
- assigned_atany
- orderany
- fileany
- created_atstring, nullable
  Example: 2026-10-30T16:48:56Z
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.

Example

GET/licences

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

const res = await fetch("https://app.filemonk.io/api/v2/external/licences", {
  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/licences",
    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/licences")
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)

GET/licences

curl "https://app.filemonk.io/api/v2/external/licences?key_status=pending&source=uploaded&tag=ebook-2026" \
  -H "X-Auth-Token: $FILEMONK_API_KEY"

const res = await fetch("https://app.filemonk.io/api/v2/external/licences?key_status=pending&source=uploaded&tag=ebook-2026", {
  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/licences?key_status=pending&source=uploaded&tag=ebook-2026",
    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/licences?key_status=pending&source=uploaded&tag=ebook-2026")
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": [
    {
      "id": "bcc87d33-c87e-4f39-9cd2-e43250ebc1ed",
      "key": "ABCD-EFGH-0005",
      "source": "uploaded",
      "status": "pending",
      "tags": [
        "ebook-2026"
      ],
      "assigned_at": null,
      "order": null,
      "file": null,
      "created_at": "2026-10-30T16:48:56Z"
    }
  ],
  "meta": {
    "total_count": 8,
    "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)."
}