Skip to main content
GET
/
livestreams
/
{id}
curl -X GET "https://api.tktchurch.com/v1/livestreams/123e4567-e89b-12d3-a456-426614174000"

{
  "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"
}

​
Path Parameters

​
id
string
required
The UUID of the livestream to retrieve

​
Response

​
id
string
Livestream’s unique identifier (UUID)
​
title
string
Title of the livestream
​
description
string
Description of the livestream
​
youtubeUrl
string
YouTube URL for the livestream
​
customStreamUrl
string
Custom streaming URL
​
status
string
Current status of the livestream. One of:
  • scheduled: Upcoming livestream
  • live: Currently streaming
  • ended: Completed livestream
  • cancelled: Cancelled livestream
​
scheduledStartTime
string
Scheduled start time in ISO 8601 format
​
actualStartTime
string
Actual start time in ISO 8601 format
​
endTime
string
End time in ISO 8601 format
​
tags
array
Array of tags associated with the livestream
​
thumbnailUrl
string
URL of the livestream thumbnail
​
thumbnail
object
Thumbnail file information
​
createdByUserId
string
UUID of the user who created the livestream
​
updatedByUserId
string
UUID of the user who last updated the livestream
​
createdAt
string
Creation timestamp in ISO 8601 format
​
updatedAt
string
Last update timestamp in ISO 8601 format

​
Error Responses

​
error
object
Error details when the request fails
Common error cases:
  • 404 Not Found: Livestream not found
curl -X GET "https://api.tktchurch.com/v1/livestreams/123e4567-e89b-12d3-a456-426614174000"

{
  "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"
}