Zendesk Content
Returns Zendesk content items associated with a specific user, including enrollment status, completion percentage, and any issued certificates
Returns Zendesk content items associated with a specific user, including enrollment status, completion percentage, and any issued certificates.
GET
https://example.thoughtindustries.com/incoming/v2/users/:id/zendeskContentExample request
curl "https://example.thoughtindustries.com/incoming/v2/users/:id/zendeskContent" \
-H 'Authorization: Bearer YOUR_API_KEY'Parameters
| Name | Type | Required | Location | Description |
|---|---|---|---|---|
id | string | Yes | path | The id identifier. |
userId | uuid | Yes | query | The UUID of the user whose Zendesk content to retrieve. |
Example response
{
"data": {
"ZendeskContentsByUserId": [
{
"id": "00000000-0000-0000-0000-000000000000",
"userId": "00000000-0000-0000-0000-000000000000",
"title": "string",
"kind": "string",
"startDate": "2024-01-01T00:00:00.000Z",
"endDate": "2024-01-01T00:00:00.000Z",
"certificate": {
"id": "00000000-0000-0000-0000-000000000000",
"certificateTemplate": {
"id": "00000000-0000-0000-0000-000000000000",
"resource": null,
"resourceType": "course",
"title": "string",
"asset": "https://example.com/path",
"supplementalAssets": [
"https://example.com/path"
],
"expirationDate": "2024-01-01T00:00:00.000Z",
"expirationDays": 0,
"recertificationAction": "resetProgress",
"recertificationInstructions": "string",
"recertificationActionText": "string",
"recertificationActionUrl": "https://example.com/path",
"recertificationAutoReset": true,
"recertificationAfterDays": 0,
"userCustomField": {
"...": "..."
},
"userCustomFieldSlug": "example-slug",
"userCustomFieldValue": "string",
"customCss": "string",
"labels": [
{
"...": "..."
}
],
"isExpired": true,
"assetLibraryId": "00000000-0000-0000-0000-000000000000"
},
"user": {
"id": "00000000-0000-0000-0000-000000000000",
"email": "string",
"firstName": "string",
"abbreviatedName": "string",
"asset": "string",
"lastName": "string",
"name": "string",
"lastActiveAt": "2024-01-01T00:00:00.000Z",
"bio": "string",
"twoFactorEnabled": true,
"firstInitial": "string",
"lastInitial": "string",
"invitedByName": "string",
"shouldHighlight": true,
"purchasedCourses": [
{
"...": "..."
}
],
"purchasedBundles": [
{
"...": "..."
}
],
"activeLicense": {
"...": "..."
},
"allocatedLicenses": [
{
"...": "..."
}
],
"allocatedLearningPaths": [
{
"...": "..."
}
],
"attendedMeetings": [
{
"...": "..."
}
],
"waitlistedCourses": [
{
"...": "..."
}
],
"adminClients": [
{
"...": "..."
}
],
"roleKey": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"country": "string",
"telephone": "string",
"stripeCustomerId": "00000000-0000-0000-0000-000000000000",
"externalCustomerId": "00000000-0000-0000-0000-000000000000",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"sfAccountId": "00000000-0000-0000-0000-000000000000",
"sfContactId": "00000000-0000-0000-0000-000000000000",
"shippingName": "string",
"client": {
"...": "..."
},
"clientId": "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",
"lang": "string",
"preferredCurrency": "string",
"customFields": {},
"recommendedTags": [
{
"...": "..."
}
],
"recommendedSlugs": [
{
"...": "..."
}
],
"accessedFlows": [
"string"
],
"disabled": true,
"learnerUserId": "00000000-0000-0000-0000-000000000000",
"managerUserId": "00000000-0000-0000-0000-000000000000",
"balance": 0,
"mustVerifyEmail": true,
"certificatesCount": 0,
"collaborationsCount": 0,
"availableCoursesCount": 0,
"startedCoursesCount": 0,
"completedCoursesCount": 0
},
"issuedAt": "2024-01-01T00:00:00.000Z",
"url": "https://example.com/path",
"pdfAsset": "https://example.com/path",
"resource": null,
"resourceType": "course",
"resourceTypeLabel": "string",
"resourceId": "00000000-0000-0000-0000-000000000000",
"progressWasReset": true,
"expirationDate": "2024-01-01T00:00:00.000Z",
"didExpire": true,
"deleted": true,
"recertificationDate": "2024-01-01T00:00:00.000Z",
"isExpired": true,
"source": "string",
"contentItem": {
"id": "00000000-0000-0000-0000-000000000000",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"expiresAt": "2024-01-01T00:00:00.000Z",
"courseGroup": "string",
"title": "string",
"sessionTitle": "string",
"ribbon": {
"...": "..."
},
"slug": "example-slug",
"kind": "courseGroup",
"metaTitle": "string",
"language": "string",
"metaDescription": "string",
"displayCourse": "00000000-0000-0000-0000-000000000000",
"displayCourseSlug": "example-slug",
"displayDate": "2024-01-01T00:00:00.000Z",
"availabilityStatus": "string",
"asset": "string",
"assetAltText": "string",
"freeWithRegistration": true,
"priceInCents": 0,
"suggestedRetailPriceInCents": 0,
"alternativePricingType": "membership",
"alternativePricingRef": 0,
"rating": 0,
"description": "string",
"sku": "string",
"hasChildren": true,
"tags": [
{
"...": "..."
}
],
"status": "draft",
"customFields": {},
"authors": [
"string"
],
"authorsAndInstructors": [
"string"
],
"contentTypeLabel": "string",
"contentTypeAssetAspectRatio": "string",
"waitlistCount": 0,
"seatsLimit": 0,
"enrollmentCount": 0,
"source": "string",
"publishDate": "2024-01-01T00:00:00.000Z",
"courseStartDate": "2024-01-01T00:00:00.000Z",
"courseEndDate": "2024-01-01T00:00:00.000Z",
"enrollmentStartDate": "2024-01-01T00:00:00.000Z",
"enrollmentEndDate": "2024-01-01T00:00:00.000Z",
"timeZone": "string",
"meetingStartDate": "2024-01-01T00:00:00.000Z",
"coursePresold": true,
"courseGracePeriodEnded": true,
"currentUserMayReschedule": true,
"isActive": true,
"embeddedEnabled": true,
"altDescriptionBody": "string",
"hideCourseDescription": true,
"annotationsEnabled": true,
"currentUserUnmetCoursePrerequisites": [
"00000000-0000-0000-0000-000000000000"
],
"currentUserUnmetLearningPathPrerequisites": [
"00000000-0000-0000-0000-000000000000"
],
"currentUserDueDate": "2024-01-01T00:00:00.000Z",
"url": "https://example.com/path",
"waitlistingEnabled": true,
"waitlistingTriggered": true,
"canAddToQueue": true,
"bulkPurchasingEnabled": true,
"prices": [
{
"...": "..."
}
],
"location": {
"...": "..."
},
"state": "string",
"acceptBadgeUrl": "string",
"issuedAt": "2024-01-01T00:00:00.000Z",
"badgeUrl": "string",
"credlyBadgeExpiresAt": "2024-01-01T00:00:00.000Z",
"imageUrl": "string",
"badgeName": "string",
"completedPassedDueDate": true
},
"isExternal": true,
"externalResourceTitle": "string",
"identifier": "string"
},
"percentComplete": 0,
"status": "string"
}
]
}
}Response fields
| Field | Type | Description |
|---|---|---|
[].id | uuid | Unique identifier for the Zendesk content item. |
[].userId | uuid | UUID of the user associated with this content item. |
[].title | string | Display title of the content item. |
[].kind | string | The content type classification (e.g., course, learning path). |
[].startDate | ISO 8601 timestamp | Date and time when the user's access to the content began. |
[].endDate | ISO 8601 timestamp | Date and time when the user's access to the content ends. |
[].certificate | Certificate | Certificate issued to the user upon completing this content item. |
[].certificate.id | uuid | Unique identifier for the certificate. |
[].certificate.certificateTemplate | CertificateTemplate | Template used to generate this certificate. |
[].certificate.user | User | User to whom the certificate was issued. |
[].certificate.issuedAt | ISO 8601 timestamp | Date and time the certificate was issued. |
[].certificate.url | string | URL where the certificate can be viewed online. |
[].certificate.pdfAsset | string | URL of the downloadable PDF version of the certificate. |
[].certificate.resource | CertificateResource | The resource (e.g., course or learning path) linked to this certificate. |
[].certificate.resourceType | CertificateResourceType | The type of resource associated with the certificate, such as course. |
[].certificate.resourceTypeLabel | string | Human-readable label for the resource type. |
[].certificate.resourceId | uuid | UUID of the resource for which the certificate was issued. |
[].certificate.progressWasReset | boolean | Indicates whether the user's progress was reset before this certificate was issued. |
[].certificate.expirationDate | ISO 8601 timestamp | Date and time the certificate expires. |
[].certificate.didExpire | boolean | Indicates whether the certificate has already expired. |
[].certificate.deleted | boolean | Indicates whether the certificate has been deleted. |
[].certificate.recertificationDate | ISO 8601 timestamp | Date and time by which the user must complete recertification. |
[].certificate.isExpired | boolean | Indicates whether the certificate is currently in an expired state. |
[].certificate.source | string | Origin or system from which the certificate was generated. |
[].certificate.contentItem | Content | Content item associated with the certificate. |
[].certificate.isExternal | boolean | Indicates whether the certificate was issued for an externally hosted resource. |
[].certificate.externalResourceTitle | string | Title of the external resource for which the certificate was issued. |
[].certificate.identifier | string | Unique identifier string assigned to the certificate, used for tracking or display. |
[].percentComplete | integer | User's completion progress for this content item, expressed as a percentage (0–100). |
[].status | string | Current enrollment or completion status of the content item for the user. |