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.

GEThttps://example.thoughtindustries.com/incoming/v2/content

Example 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

{
  "pageInfo": {
    "total": 0,
    "cursor": "string",
    "hasMore": true
  },
  "contentItems": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z",
      "hasChildren": true,
      "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",
      "kind": "courseGroup",
      "language": "string",
      "contentTypeLabel": "string",
      "asset": "string",
      "assetAltText": "string",
      "title": "string",
      "slug": "example-slug",
      "description": "string",
      "metaTitle": "string",
      "metaDescription": "string",
      "sku": "string",
      "customFields": {},
      "authorsAndInstructors": [
        "string"
      ],
      "seatsLimit": 0,
      "enrollmentCount": 0,
      "status": "draft",
      "source": "string",
      "freeWithRegistration": true,
      "priceInCents": 0,
      "suggestedRetailPriceInCents": 0,
      "waitlistingEnabled": true,
      "waitlistingTriggered": true,
      "waitlistCount": 0,
      "url": "https://example.com/path",
      "tags": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "label": "string"
        }
      ],
      "prices": [
        {
          "currencyCode": "string",
          "unitAmount": 0,
          "suggestedRetailUnitAmount": 0,
          "instructorAccessUnitAmount": 0,
          "annualUnitAmount": 0,
          "bulkPurchasingEnabled": true,
          "bulkPurchaseTiers": {
            "seatTiers": [
              {
                "seats": 0,
                "unitAmount": 0
              }
            ],
            "seatPackages": [
              {
                "seats": 0
              }
            ],
            "lastTierPriceUnitAmount": 0
          },
          "seatTiers": [
            {
              "seats": 0,
              "unitAmount": 0
            }
          ],
          "seatPackages": [
            {
              "seats": 0
            }
          ],
          "locale": "string",
          "isDefault": true
        }
      ]
    }
  ]
}

Response fields

Field	Type	Description
`pageInfo`	`CursorPageInfo`	Pagination metadata for the current result set.
`pageInfo.total`	`integer`	Total number of content items matching the query.
`pageInfo.cursor`	`string`	Opaque cursor to pass in the next request to retrieve the following page.
`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.hasChildren`	`boolean`	Indicates whether the content item contains child content items.
`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.kind`	`ContentKind`	Content type category, such as `courseGroup` or another supported kind.
`contentItems.language`	`string`	BCP 47 language code indicating the content item's primary language.
`contentItems.contentTypeLabel`	`string`	Human-readable label for the content item's type, shown in the UI.
`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.title`	`string`	Display title of the content item.
`contentItems.slug`	`string`	URL-friendly identifier for the content item.
`contentItems.description`	`string`	Full text description of the content item.
`contentItems.metaTitle`	`string`	SEO meta title for the content item's page.
`contentItems.metaDescription`	`string`	SEO meta description for the content item's page.
`contentItems.sku`	`string`	Stock-keeping unit identifier used for catalog or integration purposes.
`contentItems.customFields`	`object`	Key-value map of custom metadata fields defined for the content item.
`contentItems.authorsAndInstructors`	`string[]`	Combined list of author and instructor names associated with 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.status`	`Status`	Publication status of the content item, such as `draft` or `published`.
`contentItems.source`	`string`	Origin or integration source identifier for the content item.
`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.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.waitlistCount`	`integer`	Number of learners currently on the waitlist for the content item.
`contentItems.url`	`string`	Absolute URL to the content item's detail page.
`contentItems.tags`	`Tag[]`	Array of tags associated with the content item for categorization and filtering.
`contentItems.tags.id`	`uuid`	Unique identifier of the tag.
`contentItems.tags.label`	`string`	Display name of the tag.
`contentItems.prices`	`ItemPrice[]`	Array of pricing objects available for the content item, including currency and tier details.
`contentItems.prices.currencyCode`	`string`	ISO currency code for this price.
`contentItems.prices.unitAmount`	`integer`	Unit price amount.
`contentItems.prices.suggestedRetailUnitAmount`	`integer`	Suggested retail unit price amount.
`contentItems.prices.instructorAccessUnitAmount`	`integer`	Unit price amount for instructor access.
`contentItems.prices.annualUnitAmount`	`integer`	Annual unit price amount.
`contentItems.prices.bulkPurchasingEnabled`	`boolean`	Indicates whether bulk seat purchasing is enabled for this price.
`contentItems.prices.bulkPurchaseTiers`	`object`	Bulk purchase tier configuration for this price.
`contentItems.prices.seatTiers`	`object[]`	Seat-based pricing tiers.
`contentItems.prices.seatPackages`	`object[]`	Seat package pricing options.
`contentItems.prices.locale`	`string`	Locale this price applies to.
`contentItems.prices.isDefault`	`boolean`	Indicates whether this is the default price for the content item.