Clients

Returns a single client record by ID, including its courses, learning paths, licenses, appearance settings, SSO configuration, and catalog configuration

Returns a single client record by ID, including its courses, learning paths, licenses, appearance settings, SSO configuration, and catalog configuration.

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

Example request

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

Parameters

Name	Type	Required	Location	Description
`id`	`uuid`	Yes	path	The unique identifier of the client to retrieve.

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "learningPathIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "courseIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "courseTags": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "label": "string"
    }
  ],
  "licenseEndDate": "2024-01-01T00:00:00.000Z",
  "sku": "string",
  "slug": "string",
  "seatsAllocatedCount": 0,
  "seatsLimit": 0,
  "seatsUsedCount": 0,
  "startingBalance": 0,
  "currentBalance": 0,
  "tags": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "label": "string"
    }
  ],
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "notificationEmails": "string",
  "enableSegmentation": true,
  "enableDiscussions": true,
  "enableCommunitiesSegmentation": true,
  "enableBranding": true,
  "enableEcommerce": true,
  "enableOnboardingSurvey": true,
  "enableRecommendationAssessment": true,
  "enableNavLinks": true,
  "enableLicenseDashboards": true,
  "languages": [
    "string"
  ],
  "enableContentDetailPage": true,
  "enableCreditPurchasing": true,
  "disabled": true
}

Response fields

Field	Type	Description
`id`	`uuid`	Identifier of the client.
`name`	`string`	Name of the client.
`learningPathIds`	`uuid[]`	Identifiers of learning paths available to the client.
`courseIds`	`uuid[]`	Identifiers of courses available to the client.
`courseTags`	`object[]`	Course tags available to the client.
`courseTags.id`	`uuid`	Identifier of the tag.
`courseTags.label`	`string`	Display label of the tag.
`licenseEndDate`	`ISO 8601 timestamp`	End date of the client license.
`sku`	`string`	SKU of the client.
`slug`	`string`	URL slug of the client.
`seatsAllocatedCount`	`integer`	Number of seats allocated.
`seatsLimit`	`integer`	Maximum number of seats.
`seatsUsedCount`	`integer`	Number of seats currently used.
`startingBalance`	`number`	Starting credit balance.
`currentBalance`	`number`	Current credit balance.
`tags`	`object[]`	Tags applied to the client.
`tags.id`	`uuid`	Identifier of the tag.
`tags.label`	`string`	Display label of the tag.
`createdAt`	`ISO 8601 timestamp`	Timestamp when the client was created.
`updatedAt`	`ISO 8601 timestamp`	Timestamp when the client was last updated.
`notificationEmails`	`string`	Comma-separated notification email addresses.
`enableSegmentation`	`boolean`	Whether segmentation is enabled.
`enableDiscussions`	`boolean`	Whether discussions are enabled.
`enableCommunitiesSegmentation`	`boolean`	Whether communities segmentation is enabled.
`enableBranding`	`boolean`	Whether custom branding is enabled.
`enableEcommerce`	`boolean`	Whether ecommerce is enabled.
`enableOnboardingSurvey`	`boolean`	Whether the onboarding survey is enabled.
`enableRecommendationAssessment`	`boolean`	Whether the recommendation assessment is enabled.
`enableNavLinks`	`boolean`	Whether navigation links are enabled.
`enableLicenseDashboards`	`boolean`	Whether license dashboards are enabled.
`languages`	`string[]`	Languages configured for the client.
`enableContentDetailPage`	`boolean`	Whether the content detail page is enabled.
`enableCreditPurchasing`	`boolean`	Whether credit purchasing is enabled.
`disabled`	`boolean`	Whether the client is disabled.