Content
Returns a paginated list of content items matching the specified types and optional filters
Returns a paginated list of content items matching the specified types and optional filters.
GET
https://example.thoughtindustries.com/incoming/v2/contentExample request
curl "https://example.thoughtindustries.com/incoming/v2/content" \
-H 'Authorization: Bearer YOUR_API_KEY'Parameters
| Name | Type | Required | Location | Description |
|---|---|---|---|---|
types | ContentSearchType[] | Yes | query | One or more content types to include in the search results. |
cursor | string | No | query | Opaque cursor string for fetching the next page of results. |
perPage | integer | No | query | Number of content items to return per page. |
sort | string | No | query | Field name to sort results by. |
query | string | No | query | Full-text search string to filter content items by title or description. |
Example response
{
"data": {
"APIContentSearch": {
"pageInfo": {
"perPage": 0,
"cursor": "string",
"total": 0,
"hasMore": true
},
"contentItems": [
{
"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": {
"label": "string",
"slug": "example-slug",
"color": "string",
"contrastColor": "string",
"darkerColor": "string"
},
"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": [
{
"id": "00000000-0000-0000-0000-000000000000",
"label": "string",
"isFolder": true,
"updatedAt": "2024-01-01T00:00:00.000Z",
"description": "string"
}
],
"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": [
{
"id": "00000000-0000-0000-0000-000000000000",
"currencyCode": "string",
"unitAmount": 0,
"suggestedRetailUnitAmount": 0,
"annualUnitAmount": 0,
"unitsAmount": [
0
],
"instructorAccessUnitAmount": 0,
"variations": [
{
"...": "..."
}
],
"locale": "string",
"isDefault": true,
"alternativePricingRef": 0,
"alternativePricingType": "membership",
"bulkPurchasingEnabled": true,
"seatTiers": [
{
"...": "..."
}
],
"seatPackages": [
{
"...": "..."
}
],
"lastTierPriceUnitAmount": 0,
"bulkPurchaseTiers": [
{
"...": "..."
}
]
}
],
"location": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"room": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"country": "string",
"timeZone": "string"
},
"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
}
]
}
}
}Response fields
| Field | Type | Description |
|---|---|---|
pageInfo | CursorPageInfo | Pagination metadata for the current result set. |
pageInfo.perPage | integer | Number of items returned per page. |
pageInfo.cursor | string | Opaque cursor to pass in the next request to retrieve the following page. |
pageInfo.total | integer | Total number of content items matching the query. |
pageInfo.hasMore | boolean | Indicates whether additional pages of results are available. |
contentItems | Content[] | Array of content items matching the search criteria. |
contentItems.id | uuid | Unique identifier of the content item. |
contentItems.createdAt | ISO 8601 timestamp | Date and time the content item was created. |
contentItems.updatedAt | ISO 8601 timestamp | Date and time the content item was last modified. |
contentItems.expiresAt | ISO 8601 timestamp | Date and time after which access to the content item expires. |
contentItems.courseGroup | string | Identifier of the course group this item belongs to. |
contentItems.title | string | Display title of the content item. |
contentItems.sessionTitle | string | Title of the specific session, if the content item represents a scheduled session. |
contentItems.ribbon | Ribbon | Ribbon badge displayed on the content item's card, including label and color values. |
contentItems.slug | string | URL-friendly identifier for the content item. |
contentItems.kind | ContentKind | Content type category, such as courseGroup or another supported kind. |
contentItems.metaTitle | string | SEO meta title for the content item's page. |
contentItems.language | string | BCP 47 language code indicating the content item's primary language. |
contentItems.metaDescription | string | SEO meta description for the content item's page. |
contentItems.displayCourse | uuid | Unique identifier of the course used for display purposes. |
contentItems.displayCourseSlug | string | URL slug of the course used for display purposes. |
contentItems.displayDate | ISO 8601 timestamp | Date shown to learners as the content item's featured or release date. |
contentItems.availabilityStatus | string | Human-readable string describing the content item's current availability. |
contentItems.asset | string | URL or identifier of the content item's primary thumbnail or cover image asset. |
contentItems.assetAltText | string | Accessible alt text for the content item's primary image asset. |
contentItems.freeWithRegistration | boolean | Indicates whether the content item is available at no cost upon registration. |
contentItems.priceInCents | integer | List price of the content item in cents (e.g., 1000 = $10.00). |
contentItems.suggestedRetailPriceInCents | integer | Suggested retail price of the content item in cents. |
contentItems.alternativePricingType | AlternativePricingType | Type of alternative pricing applied, such as membership. |
contentItems.alternativePricingRef | integer | Reference identifier for the associated alternative pricing plan. |
contentItems.rating | integer | Aggregate learner rating for the content item. |
contentItems.description | string | Full text description of the content item. |
contentItems.sku | string | Stock-keeping unit identifier used for catalog or integration purposes. |
contentItems.hasChildren | boolean | Indicates whether the content item contains child content items. |
contentItems.tags | Tag[] | Array of tags associated with the content item for categorization and filtering. |
contentItems.status | Status | Publication status of the content item, such as draft or published. |
contentItems.customFields | object | Key-value map of custom metadata fields defined for the content item. |
contentItems.authors | string[] | List of author names credited on the content item. |
contentItems.authorsAndInstructors | string[] | Combined list of author and instructor names associated with the content item. |
contentItems.contentTypeLabel | string | Human-readable label for the content item's type, shown in the UI. |
contentItems.contentTypeAssetAspectRatio | string | Expected aspect ratio of the content type's thumbnail asset (e.g., 16:9). |
contentItems.waitlistCount | integer | Number of learners currently on the waitlist for the content item. |
contentItems.seatsLimit | integer | Maximum number of enrollments allowed for the content item. |
contentItems.enrollmentCount | integer | Total number of active enrollments for the content item. |
contentItems.source | string | Origin or integration source identifier for the content item. |
contentItems.publishDate | ISO 8601 timestamp | Date and time the content item was or is scheduled to be published. |
contentItems.courseStartDate | ISO 8601 timestamp | Date and time the course officially begins. |
contentItems.courseEndDate | ISO 8601 timestamp | Date and time the course officially ends. |
contentItems.enrollmentStartDate | ISO 8601 timestamp | Date and time enrollment opens for the content item. |
contentItems.enrollmentEndDate | ISO 8601 timestamp | Date and time enrollment closes for the content item. |
contentItems.timeZone | string | IANA time zone identifier used for all schedule dates on this content item. |
contentItems.meetingStartDate | ISO 8601 timestamp | Date and time of the first scheduled meeting for the content item. |
contentItems.coursePresold | boolean | Indicates whether the course is available for purchase before it officially starts. |
contentItems.courseGracePeriodEnded | boolean | Indicates whether the post-course access grace period has elapsed. |
contentItems.currentUserMayReschedule | boolean | Indicates whether the authenticated user is permitted to reschedule their enrollment. |
contentItems.isActive | boolean | Indicates whether the content item is currently active and accessible. |
contentItems.embeddedEnabled | boolean | Indicates whether the content item can be embedded in external pages. |
contentItems.altDescriptionBody | string | Alternate description body used in place of the primary description in certain display contexts. |
contentItems.hideCourseDescription | boolean | Indicates whether the course description is hidden from learners on the detail page. |
contentItems.annotationsEnabled | boolean | Indicates whether learners can add annotations within the content item. |
contentItems.currentUserUnmetCoursePrerequisites | uuid[] | IDs of course prerequisites the authenticated user has not yet completed. |
contentItems.currentUserUnmetLearningPathPrerequisites | uuid[] | IDs of learning path prerequisites the authenticated user has not yet completed. |
contentItems.currentUserDueDate | ISO 8601 timestamp | Date by which the authenticated user must complete the content item. |
contentItems.url | string | Absolute URL to the content item's detail page. |
contentItems.waitlistingEnabled | boolean | Indicates whether waitlisting is enabled for the content item. |
contentItems.waitlistingTriggered | boolean | Indicates whether the waitlist has been activated due to the enrollment limit being reached. |
contentItems.canAddToQueue | boolean | Indicates whether the authenticated user can add the content item to their learning queue. |
contentItems.bulkPurchasingEnabled | boolean | Indicates whether bulk seat purchasing is enabled for the content item. |
contentItems.prices | ItemPrice[] | Array of pricing objects available for the content item, including currency and tier details. |
contentItems.location | Location | Physical location details for in-person or blended content items. |
contentItems.state | string | Current workflow or lifecycle state of the content item. |
contentItems.acceptBadgeUrl | string | URL the learner visits to claim or accept the awarded badge. |
contentItems.issuedAt | ISO 8601 timestamp | Date and time the badge was issued to the learner. |
contentItems.badgeUrl | string | URL of the badge image awarded upon completion. |
| `contentItems.credlyBadgeExpiresAt |