Documentation Index

Fetch the complete documentation index at: https://docs.grassfish.com/llms.txt

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

Gets a single broadcast by its ID.

  • Updated on Mar 20, 2026
  • Published on Jul 23, 2025
  • 3 minute(s) reading time
Prev Next
Get
/api/broadcasts/{broadcastId}
Security
OAuth

Authorization using OAuth2 with Client Credentials

FlowClient Credentials
Authorization URLhttps://identity.eu01.grassfish.com/connect/authorize
Token URLhttps://identity.eu01.grassfish.com/connect/token
Header parameters
x-correlationToken
string
x-clientId
string

The external ID of the client.

Min length0
Max length128
x-onBehalfOf
string
Min length0
Max length24
api-version
string
Path parameters
broadcastId
stringRequired

The ID of the broadcast to retrieve.

Min length0
Max length128
Responses
200

OK

Expand All
object
success
object (Contracts.Common.Jsons.Common.SuccessJson)
ok
boolean
message
string | null
unauthorizedAccess
boolean | null
notFound
boolean | null
correlationToken
string | null
errors
Array of object (Contracts.Common.Jsons.Common.SuccessJsonError) | null
object
message
string | null
id
string
Valid values[ "InvalidDatePeriodEndDateBeforeStartDate", "NameAlreadyTaken", "ExternalIdAlreadyTaken", "CodeAlreadyTaken" ]
fieldName
string | null
isRequired
boolean | null
isOutOfRange
boolean | null
isTaken
boolean | null
errorCode
string | null
defaultDisplayMessage
string | null
errorCode
string | null
details
object (Contracts.Common.Jsons.Common.ErrorDetailsJson)
message
string | null
defaultDisplayMessage
string | null
broadcast
object (Contracts.Connect.Results.Broadcasts.SelectSingleBroadcastJson)
code
string | null
id
string | null
name
string | null
bookingType
string
Valid values[ "None", "Normal", "Filler", "PlayerDefaultPlaylist", "SoV" ]
periods
Array of object (Contracts.Connect.Results.Broadcasts.SelectSingleBroadcastPeriodJson) | null
object
startDateTime
string (date-time) | null
endDateTime
string (date-time) | null
groups
Array of object (Contracts.Connect.Results.Broadcasts.SelectSingleBroadcastGroupJson) | null
object
code
string | null
id
string | null
name
string | null
spotLengthSecs
number (double) | null
media
Array of object (Contracts.Connect.Results.Broadcasts.SelectSingleBroadcastGroupMediaJson) | null
object
code
string | null
id
string | null
name
string | null
durationSecs
number (double) | null
mediaDurationSecs
number (double) | null
mediaType
string
Valid values[ "None", "Audio", "Video", "Photo", "Text", "HtmlSign", "Json", "HtmlTemplate", "WebPage", "File" ]
Expand All
object
success
object (Contracts.Common.Jsons.Common.SuccessJson)
ok
boolean
message
string | null
unauthorizedAccess
boolean | null
notFound
boolean | null
correlationToken
string | null
errors
Array of object (Contracts.Common.Jsons.Common.SuccessJsonError) | null
object
message
string | null
id
string
Valid values[ "InvalidDatePeriodEndDateBeforeStartDate", "NameAlreadyTaken", "ExternalIdAlreadyTaken", "CodeAlreadyTaken" ]
fieldName
string | null
isRequired
boolean | null
isOutOfRange
boolean | null
isTaken
boolean | null
errorCode
string | null
defaultDisplayMessage
string | null
errorCode
string | null
details
object (Contracts.Common.Jsons.Common.ErrorDetailsJson)
message
string | null
defaultDisplayMessage
string | null
broadcast
object (Contracts.Connect.Results.Broadcasts.SelectSingleBroadcastJson)
code
string | null
id
string | null
name
string | null
bookingType
string
Valid values[ "None", "Normal", "Filler", "PlayerDefaultPlaylist", "SoV" ]
periods
Array of object (Contracts.Connect.Results.Broadcasts.SelectSingleBroadcastPeriodJson) | null
object
startDateTime
string (date-time) | null
endDateTime
string (date-time) | null
groups
Array of object (Contracts.Connect.Results.Broadcasts.SelectSingleBroadcastGroupJson) | null
object
code
string | null
id
string | null
name
string | null
spotLengthSecs
number (double) | null
media
Array of object (Contracts.Connect.Results.Broadcasts.SelectSingleBroadcastGroupMediaJson) | null
object
code
string | null
id
string | null
name
string | null
durationSecs
number (double) | null
mediaDurationSecs
number (double) | null
mediaType
string
Valid values[ "None", "Audio", "Video", "Photo", "Text", "HtmlSign", "Json", "HtmlTemplate", "WebPage", "File" ]
Expand All
object
success
object (Contracts.Common.Jsons.Common.SuccessJson)
ok
boolean
message
string | null
unauthorizedAccess
boolean | null
notFound
boolean | null
correlationToken
string | null
errors
Array of object (Contracts.Common.Jsons.Common.SuccessJsonError) | null
object
message
string | null
id
string
Valid values[ "InvalidDatePeriodEndDateBeforeStartDate", "NameAlreadyTaken", "ExternalIdAlreadyTaken", "CodeAlreadyTaken" ]
fieldName
string | null
isRequired
boolean | null
isOutOfRange
boolean | null
isTaken
boolean | null
errorCode
string | null
defaultDisplayMessage
string | null
errorCode
string | null
details
object (Contracts.Common.Jsons.Common.ErrorDetailsJson)
message
string | null
defaultDisplayMessage
string | null
broadcast
object (Contracts.Connect.Results.Broadcasts.SelectSingleBroadcastJson)
code
string | null
id
string | null
name
string | null
bookingType
string
Valid values[ "None", "Normal", "Filler", "PlayerDefaultPlaylist", "SoV" ]
periods
Array of object (Contracts.Connect.Results.Broadcasts.SelectSingleBroadcastPeriodJson) | null
object
startDateTime
string (date-time) | null
endDateTime
string (date-time) | null
groups
Array of object (Contracts.Connect.Results.Broadcasts.SelectSingleBroadcastGroupJson) | null
object
code
string | null
id
string | null
name
string | null
spotLengthSecs
number (double) | null
media
Array of object (Contracts.Connect.Results.Broadcasts.SelectSingleBroadcastGroupMediaJson) | null
object
code
string | null
id
string | null
name
string | null
durationSecs
number (double) | null
mediaDurationSecs
number (double) | null
mediaType
string
Valid values[ "None", "Audio", "Video", "Photo", "Text", "HtmlSign", "Json", "HtmlTemplate", "WebPage", "File" ]
400

Bad Request

object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
401

Unauthorized

403

Forbidden

object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
500

Internal Server Error

Products
Company
Support
Follow us
© 2025 Grassfish. All Rights Reserved.