Show Licenses

Returns a paginated list of licenses associated with a client

Returns a paginated list of licenses associated with a client.

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

Example request

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

Parameters

Name	Type	Required	Location	Description
`id`	`string`	Yes	path	The id identifier.
`clientId`	`uuid`	Yes	query	The UUID of the client whose licenses to retrieve.
`cursor`	`string`	No	query	Opaque cursor for the next page of results. Omit to fetch the first page.

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "sku": "string",
  "pageInfo": {
    "total": 0,
    "hasMore": true,
    "cursor": "string"
  },
  "licenses": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "sku": "string",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z",
      "accessDays": 0,
      "expirationDate": "2024-01-01T00:00:00.000Z",
      "seatsLimit": 0,
      "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 client whose licenses are returned.
`name`	`string`	Name of the client.
`sku`	`string`	SKU of the client.
`pageInfo`	`object`	Cursor-based pagination metadata for the result set.
`pageInfo.total`	`integer`	Total number of records matching the query.
`pageInfo.hasMore`	`boolean`	Whether additional pages of results are available.
`pageInfo.cursor`	`string`	Opaque cursor to pass on the next request. Present when `hasMore` is `true`.
`licenses`	`object[]`	Array of license objects for the current page.
`licenses.id`	`uuid`	Identifier of the license.
`licenses.name`	`string`	Name of the license.
`licenses.sku`	`string`	SKU of the license.
`licenses.createdAt`	`ISO 8601 timestamp`	Timestamp when the license was created.
`licenses.updatedAt`	`ISO 8601 timestamp`	Timestamp when the license was last updated.
`licenses.accessDays`	`integer`	Number of access days granted by the license.
`licenses.expirationDate`	`ISO 8601 timestamp`	Expiration date of the license.
`licenses.seatsLimit`	`integer`	Maximum number of seats on the license.
`licenses.learningPathIds`	`uuid[]`	Identifiers of learning paths granted by the license.
`licenses.courseIds`	`uuid[]`	Identifiers of courses granted by the license.
`licenses.courseTags`	`object[]`	Course tags granted by the license.
`licenses.courseTags.id`	`uuid`	Identifier of the tag.
`licenses.courseTags.label`	`string`	Display label of the tag.
`licenses.parentLicenseId`	`uuid`	Identifier of the parent license, when nested.
`licenses.ref1`	`string`	Custom reference field 1 on the license.
`licenses.ref2`	`string`	Custom reference field 2 on the license.
`licenses.ref3`	`string`	Custom reference field 3 on the license.
`licenses.ref4`	`string`	Custom reference field 4 on the license.
`licenses.ref5`	`string`	Custom reference field 5 on the license.
`licenses.ref6`	`string`	Custom reference field 6 on the license.
`licenses.ref7`	`string`	Custom reference field 7 on the license.
`licenses.ref8`	`string`	Custom reference field 8 on the license.
`licenses.ref9`	`string`	Custom reference field 9 on the license.
`licenses.ref10`	`string`	Custom reference field 10 on the license.