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
}
}
Livestreams
List Livestreams
List all livestreams with optional filtering
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
Filter by livestream status. One of:
scheduled: Upcoming livestreamlive: Currently streamingended: Completed livestreamcancelled: Cancelled livestream
Filter by tag
Filter by start date (ISO 8601 format)
Filter by end date (ISO 8601 format)
Page number for pagination (default: 1)
Items per page (default: 10)
Response
Array of livestream objects
Show Livestream Object
Show Livestream Object
Livestream’s unique identifier (UUID)
Title of the livestream
Description of the livestream
YouTube URL for the livestream
Custom streaming URL
Current status of the livestream (scheduled, live, ended, or cancelled)
Scheduled start time in ISO 8601 format
Actual start time in ISO 8601 format
End time in ISO 8601 format
Array of tags associated with the livestream
URL of the livestream thumbnail
UUID of the user who created the livestream
UUID of the user who last updated the livestream
Creation timestamp in ISO 8601 format
Last update timestamp in ISO 8601 format
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
}
}
⌘I