Skip to main content
GET
/
livestreams
curl -X GET "https://api.tktchurch.com/v1/livestreams?status=live&tag=sunday-service&start=2024-01-01T00:00:00Z"

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "title": "Sunday Service",
      "description": "Join us for our weekly Sunday service",
      "youtubeUrl": "https://youtube.com/watch?v=abc123",
      "customStreamUrl": null,
      "status": "live",
      "scheduledStartTime": "2024-01-21T10:00:00Z",
      "actualStartTime": "2024-01-21T10:02:00Z",
      "endTime": null,
      "tags": ["sunday-service", "worship"],
      "thumbnailUrl": "https://example.com/thumbnail.jpg",
      "thumbnail": {
        "id": "123e4567-e89b-12d3-a456-426614174001",
        "url": "https://storage.example.com/thumbnails/abc123.jpg",
        "provider": "s3",
        "key": "thumbnails/abc123.jpg"
      },
      "createdByUserId": "123e4567-e89b-12d3-a456-426614174002",
      "updatedByUserId": "123e4567-e89b-12d3-a456-426614174002",
      "createdAt": "2024-01-20T15:00:00Z",
      "updatedAt": "2024-01-21T10:02:00Z"
    }
  ],
  "metadata": {
    "page": 1,
    "per": 10,
    "total": 1,
    "pageCount": 1
  }
}

​
Query Parameters

​
status
string
Filter by livestream status. One of:
  • scheduled: Upcoming livestream
  • live: Currently streaming
  • ended: Completed livestream
  • cancelled: Cancelled livestream
​
tag
string
Filter by tag
​
start
string
Filter by start date (ISO 8601 format)
​
end
string
Filter by end date (ISO 8601 format)
​
page
integer
Page number for pagination (default: 1)
​
per
integer
Items per page (default: 10)

​
Response

​
items
array
Array of livestream objects
​
metadata
object
Pagination metadata
curl -X GET "https://api.tktchurch.com/v1/livestreams?status=live&tag=sunday-service&start=2024-01-01T00:00:00Z"

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "title": "Sunday Service",
      "description": "Join us for our weekly Sunday service",
      "youtubeUrl": "https://youtube.com/watch?v=abc123",
      "customStreamUrl": null,
      "status": "live",
      "scheduledStartTime": "2024-01-21T10:00:00Z",
      "actualStartTime": "2024-01-21T10:02:00Z",
      "endTime": null,
      "tags": ["sunday-service", "worship"],
      "thumbnailUrl": "https://example.com/thumbnail.jpg",
      "thumbnail": {
        "id": "123e4567-e89b-12d3-a456-426614174001",
        "url": "https://storage.example.com/thumbnails/abc123.jpg",
        "provider": "s3",
        "key": "thumbnails/abc123.jpg"
      },
      "createdByUserId": "123e4567-e89b-12d3-a456-426614174002",
      "updatedByUserId": "123e4567-e89b-12d3-a456-426614174002",
      "createdAt": "2024-01-20T15:00:00Z",
      "updatedAt": "2024-01-21T10:02:00Z"
    }
  ],
  "metadata": {
    "page": 1,
    "per": 10,
    "total": 1,
    "pageCount": 1
  }
}