Skip to main content
GET
/
home
Get home feed
curl --request GET \
  --url https://api.thehaystack.ai/v2/haystack/home \
  --header 'Authorization: Bearer <token>'
{
  "recentItems": [
    {
      "id": 123,
      "title": "The Power of Prayer",
      "subTitle": "<string>",
      "description": "<string>",
      "shortDescription": "<string>",
      "date": "2025-01-15",
      "collectionId": 123,
      "seriesId": 123,
      "orderInSeries": 123,
      "urlSlug": "<string>",
      "durationSecs": 123,
      "status": "draft",
      "wizardStep": "basicDetails",
      "publishedDate": "2023-11-07T05:31:56Z",
      "autoPublish": true,
      "squareImgUrl": "<string>",
      "wideImgUrl": "<string>",
      "ultraWideImgUrl": "<string>",
      "verticalImgUrl": "<string>",
      "entryDate": "2023-11-07T05:31:56Z",
      "collection": {
        "id": 1,
        "name": "Sunday Sermons",
        "itemDescriptor": "sermon",
        "contentFormat": "sermon",
        "fullService": false,
        "variantTypes": [
          {
            "id": 123,
            "name": "Sermon Video",
            "contentType": "video",
            "indexable": true,
            "displayOrder": 123,
            "collectionId": 123
          }
        ]
      },
      "series": {
        "id": 123,
        "title": "The Gospel of John",
        "subTitle": "<string>",
        "collectionId": 123,
        "description": "<string>",
        "shortDescription": "<string>",
        "sortOrder": 123,
        "itemSortDirection": "DESC",
        "showItemOrderInSeries": true,
        "urlSlug": "<string>",
        "colorHex": "#FF5733",
        "squareImgUrl": "<string>",
        "wideImgUrl": "<string>",
        "ultraWideImgUrl": "<string>",
        "published": true,
        "verticalImgUrl": "<string>",
        "squareImgMetadata": {},
        "wideImgMetadata": {},
        "ultraWideImgMetadata": {},
        "verticalImgMetadata": {},
        "items": "<array>",
        "collection": {
          "id": 1,
          "name": "Sunday Sermons",
          "itemDescriptor": "sermon",
          "contentFormat": "sermon",
          "fullService": false,
          "variantTypes": [
            {
              "id": 123,
              "name": "Sermon Video",
              "contentType": "video",
              "indexable": true,
              "displayOrder": 123,
              "collectionId": 123
            }
          ]
        }
      },
      "speakers": [
        {
          "id": 123,
          "name": "Pastor John Smith",
          "bio": "<string>",
          "imageUrl": "<string>",
          "imageFilename": "<string>",
          "itemCount": 123
        }
      ],
      "scriptures": [
        {
          "id": 123,
          "itemId": 123,
          "book": "<string>",
          "bookName": "Matthew",
          "chapter": 123,
          "verseStart": 123,
          "verseEnd": 123,
          "keyVerse": true,
          "suggested": true,
          "accepted": true,
          "displayOrder": 123,
          "citation": "Matthew 5:1-12",
          "hidden": true
        }
      ],
      "mediaAssets": [
        {
          "id": 123,
          "itemId": 123,
          "item": "<unknown>",
          "contentType": "audio",
          "mimeType": "<string>",
          "variantTypeId": 123,
          "variantType": {
            "id": 123,
            "name": "Sermon Video",
            "contentType": "video",
            "indexable": true,
            "displayOrder": 123,
            "collectionId": 123
          },
          "fileSizeBytes": 123,
          "durationSecs": 123,
          "bitrate": 123,
          "videoWidth": 123,
          "videoHeight": 123,
          "filename": "<string>",
          "originalFilename": "<string>",
          "externalPlatform": "youtube",
          "externalPlatformId": "<string>",
          "muxAssetId": "<string>",
          "muxPlaybackId": "<string>",
          "status": "created",
          "url": "<string>",
          "downloadUrl": "<string>",
          "chapters": [
            {
              "id": 123,
              "itemId": 123,
              "mediaAssetId": 123,
              "title": "Introduction",
              "startMs": 123,
              "suggested": true,
              "accepted": true,
              "hidden": true
            }
          ],
          "entryDate": "2023-11-07T05:31:56Z"
        }
      ],
      "resources": [
        {
          "id": 123,
          "itemId": 123,
          "title": "<string>",
          "subTitle": "<string>",
          "description": "<string>",
          "resourceTypeId": 123,
          "displayOrder": 123,
          "contentType": "file",
          "fileMimeType": "<string>",
          "fileSizeBytes": 123,
          "externalPlatform": "youtube",
          "externalPlatformId": "<string>",
          "thumbnailImgUrl": "<string>",
          "url": "<string>",
          "resourceType": {
            "id": 123,
            "name": "<string>"
          },
          "linkTarget": "<string>"
        }
      ],
      "suggestedDescription": "<string>",
      "suggestedShortDescription": "<string>",
      "errorMessage": "<string>",
      "indexedMediaAssetId": 123,
      "autoAcceptScriptures": true,
      "autoAcceptMediaChapters": true,
      "transcriptUrl": "<string>",
      "topics": [
        {
          "id": 123,
          "name": "<string>",
          "itemCount": 123
        }
      ],
      "squareImgMetadata": {},
      "wideImgMetadata": {},
      "ultraWideImgMetadata": {},
      "verticalImgMetadata": {}
    }
  ],
  "recentItemsMetadata": {
    "limit": 123,
    "offset": 123,
    "page": 123,
    "totalRecords": 123,
    "totalPages": 123,
    "hasMore": true
  },
  "series": [
    {
      "id": 123,
      "title": "The Gospel of John",
      "subTitle": "<string>",
      "collectionId": 123,
      "description": "<string>",
      "shortDescription": "<string>",
      "sortOrder": 123,
      "itemSortDirection": "DESC",
      "showItemOrderInSeries": true,
      "urlSlug": "<string>",
      "colorHex": "#FF5733",
      "squareImgUrl": "<string>",
      "wideImgUrl": "<string>",
      "ultraWideImgUrl": "<string>",
      "published": true,
      "verticalImgUrl": "<string>",
      "squareImgMetadata": {},
      "wideImgMetadata": {},
      "ultraWideImgMetadata": {},
      "verticalImgMetadata": {},
      "items": "<array>",
      "collection": {
        "id": 1,
        "name": "Sunday Sermons",
        "itemDescriptor": "sermon",
        "contentFormat": "sermon",
        "fullService": false,
        "variantTypes": [
          {
            "id": 123,
            "name": "Sermon Video",
            "contentType": "video",
            "indexable": true,
            "displayOrder": 123,
            "collectionId": 123
          }
        ]
      }
    }
  ],
  "seriesMetadata": {
    "limit": 123,
    "offset": 123,
    "page": 123,
    "totalRecords": 123,
    "totalPages": 123,
    "hasMore": true
  },
  "itemsInSeriesMetadata": [
    {
      "limit": 123,
      "offset": 123,
      "page": 123,
      "totalRecords": 123,
      "totalPages": 123,
      "hasMore": true
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developer.thehaystack.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Enter your API token from the Haystack dashboard

Query Parameters

collectionId
string

Filter to a single collection

Response

200 - application/json

Home feed (recent items plus series with items)

recentItems
object[]
recentItemsMetadata
object
series
object[]
seriesMetadata
object
itemsInSeriesMetadata
object[]

Pagination metadata for each series row, in the same order as series