---
title: "List licences"
description: "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 bu"
url: https://docs.filemonk.io/v2/api-reference/licences/list-licences/
api: "API v2 reference"
method: GET
path: "/licences"
---

# List licences

`GET https://app.filemonk.io/api/v2/external/licences`

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.

## Query parameters

- `key_status` (string) One of: `pending`, `assigned`, `used`.
- `source` (string) One of: `uploaded`, `auto_generated`.
- `page` (integer): 1-based page number.
- `per_page` (integer): Rows per page, max 200.
- `tag` (string)
- `search` (string)

## Returns

- `data` (array of objects, required)
  - `id` (string, nullable, required): e.g. `bcc87d33-c87e-4f39-9cd2-e43250ebc1ed`
  - `key` (string, nullable, required): e.g. `ABCD-EFGH-0005`
  - `source` (string, nullable, required): e.g. `uploaded`
  - `status` (string, nullable, required): e.g. `pending`
  - `tags` (array of strings, required)
  - `assigned_at` (any, required)
  - `order` (any, required)
  - `file` (any, required)
  - `created_at` (string, nullable, required): e.g. `2026-10-30T16:48:56Z`
- `meta` (object, required): Paging of a list (`page`, `per_page` query params).
  - `total_count` (integer, required): Rows across all pages.
  - `page` (integer, required): 1-based page number.
  - `per_page` (integer, required): Rows per page, max 200.
  - `total_pages` (integer, required): e.g. `1`
- `totals` (object, required)
  - `total` (integer, nullable, required): e.g. `8`
  - `pending` (integer, nullable, required): e.g. `6`
  - `assigned` (integer, nullable, required): e.g. `1`
  - `used` (integer, nullable, required): e.g. `1`

Rate limit: this call costs 1 point ([rate limits](https://docs.filemonk.io/v2/errors-and-rate-limits/)).

## Examples

### List licences

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

### List licences filtered by key_status, source and tag

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

## 200

Success: one page of rows.

```json
{
  "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
  }
}
```

## 401

Missing or invalid API key.

```json
{
  "errors": [
    "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.

```json
{
  "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"
    ]
  }
}
```

## 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.

```json
{
  "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)."
}
```