API Overview

The Licentric API is a RESTful JSON API for managing software licenses, machines, products, policies, entitlements, and webhooks.

Interactive API Reference

Explore all endpoints interactively at /api/reference. Try requests, view schemas, and test authentication — powered by our auto-generated OpenAPI 3.1 spec.

Base URL

All API requests are made to your instance base URL:

text

https://your-instance.licentric.com/api/v1

Request Format

All request bodies must be JSON with the Content-Type: application/json header.

Response Format

All responses are JSON. Single-resource responses use a data envelope. List responses include pagination metadata.

Single Resource

Response

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "My License",
    "status": "active",
    "createdAt": "2026-01-15T10:30:00.000Z",
    "updatedAt": "2026-01-15T10:30:00.000Z",
    "deletedAt": null,
    "metadata": {}
  }
}

List Response

Response

{
  "data": [
    { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "..." : "..." },
    { "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "..." : "..." }
  ],
  "pagination": {
    "nextCursor": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "hasMore": true
  }
}

Conventions

IDs

All resource identifiers are UUIDs (v4). Never use sequential IDs.

Timestamps

All timestamps are ISO 8601 format in UTC: 2026-01-15T10:30:00.000Z

Soft Deletes

DELETE operations set a deletedAt timestamp. Records are excluded from list queries by default.

Metadata

Most resources support a metadata JSON object for storing arbitrary key-value data.

Pagination

All list endpoints use cursor-based pagination. See the Pagination page for details.

Versioning

The API is versioned via the URL path (/api/v1). Breaking changes will be introduced under a new version prefix.

Error Handling Authentication