Licenses

Returns a single license by its unique identifier, including full details about the associated client, courses, learning paths, appearance settings, and license hierarchy

Returns a single license by its unique identifier, including full details about the associated client, courses, learning paths, appearance settings, and license hierarchy.

GEThttps://example.thoughtindustries.com/incoming/v2/licenses/:id

Example request

curl "https://example.thoughtindustries.com/incoming/v2/licenses/:id" \
  -H 'Authorization: Bearer YOUR_API_KEY'

Parameters

Name	Type	Required	Location	Description
`id`	`uuid`	Yes	path	Unique identifier of the license to retrieve.

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "label": "string",
  "sku": "string",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "expirationDate": "2024-01-01T00:00:00.000Z",
  "accessDays": 0,
  "isDefault": true,
  "seatsLimit": 0,
  "enableBranding": true,
  "learningPathIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "courseIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "courseTags": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "label": "string"
    }
  ],
  "parentLicenseId": "00000000-0000-0000-0000-000000000000",
  "ref1": "string",
  "ref2": "string",
  "ref3": "string",
  "ref4": "string",
  "ref5": "string",
  "ref6": "string",
  "ref7": "string",
  "ref8": "string",
  "ref9": "string",
  "ref10": "string"
}

Response fields

Field	Type	Description
`id`	`uuid`	Identifier of the license.
`name`	`string`	Name of the license.
`label`	`string`	Display label of the license.
`sku`	`string`	SKU of the license.
`createdAt`	`ISO 8601 timestamp`	Timestamp when the license was created.
`updatedAt`	`ISO 8601 timestamp`	Timestamp when the license was last updated.
`expirationDate`	`ISO 8601 timestamp`	Expiration date of the license.
`accessDays`	`integer`	Number of access days granted by the license.
`isDefault`	`boolean`	Whether this is the default license for the client.
`seatsLimit`	`integer`	Maximum number of seats on the license.
`enableBranding`	`boolean`	Whether custom branding is enabled for the license.
`learningPathIds`	`uuid[]`	Identifiers of learning paths granted by the license.
`courseIds`	`uuid[]`	Identifiers of courses granted by the license.
`courseTags`	`object[]`	Course tags granted by the license.
`courseTags.id`	`uuid`	Identifier of the tag.
`courseTags.label`	`string`	Display label of the tag.
`parentLicenseId`	`uuid`	Identifier of the parent license, when nested.
`ref1`	`string`	Custom reference field 1 on the license.
`ref2`	`string`	Custom reference field 2 on the license.
`ref3`	`string`	Custom reference field 3 on the license.
`ref4`	`string`	Custom reference field 4 on the license.
`ref5`	`string`	Custom reference field 5 on the license.
`ref6`	`string`	Custom reference field 6 on the license.
`ref7`	`string`	Custom reference field 7 on the license.
`ref8`	`string`	Custom reference field 8 on the license.
`ref9`	`string`	Custom reference field 9 on the license.
`ref10`	`string`	Custom reference field 10 on the license.