Resource

Licences

Licence keys: add, import, check, move and delete.

The licence object

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

Endpoints

GET/licences
POST/licences
GET/licences/{id}
PATCH/licences/{id}
DEL/licences/{id}
POST/licences/bulk_delete
POST/licences/check
POST/licences/import
GET/licences/lookup
POST/licences/move

The licence object

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