Gets a single communication mix by its ID.

Updated on Mar 20, 2026
Published on Jul 23, 2025

6 minute(s) reading time

Prev Next

Get

/api/v{version}/communicationmixes/{communicationMixId}

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

Min length0

Max length128

x-onBehalfOf

string

Min length0

Max length24

api-version

string

Path parameters

communicationMixId

stringRequired

version

stringRequired

Responses

200

Expand All

object

success

object (Contracts.Common.Jsons.Common.SuccessJson)

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

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

mix

object (Contracts.Connect.Results.Broadcasts.SelectCommunicationMixesResultCommunicationMix)

string | null

ID of the communication mix.

code

string | null

The unique code of the communication mix.

name

string | null

Name of the communication mix.

loopLengthSec

number (double) | null

Total length of one loop (all content types combined) in seconds.

contentTypes

Array of object (Contracts.Connect.Results.Broadcasts.SelectContentTypeJson) | null

List of content types that can be used in this communication mix.

object

string | null

ID of the content type.

code

string | null

Unique code of the content type.

name

string | null

Name of the content type.

durationSecs

number (double) | null

The duration of the content type in seconds.

periods

Array of object (Contracts.Connect.Results.Broadcasts.SelectPeriodJson) | null

List of periods when the communication mix is active. An empty list means always active.

object

string | null

ID of the period.

code

string | null

Unique code of the period.

startDateTime

string (date-time) | null

Start date and time of the period. If null, the period starts immediately.

endDateTime

string (date-time) | null

End date and time of the period. If null, the period does not end.

weekdayStartTime

string (date-span) | null

Start time of the period on weekdays. If null, the period starts at midnight.

weekdayEndTime

string (date-span) | null

End time of the period on weekdays. If null, the period ends at midnight.

dayOfWeeks

string

Valid values[ "None", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "NotWeekends", "Saturday", "Sunday", "Weekends", "All" ]

layers

Array of object (Contracts.Connect.Results.Broadcasts.SelectBroadcastLayerJson) | null

List of broadcast layers to which this communication mix will be applied. An empty list means all layers.

object

string | null

ID of the broadcast layer.

code

string | null

Unique code of the broadcast layer.

name

string | null

Name of the broadcast layer.

isMain

boolean | null

Defines if this layer is the main layer or not.

isSOV

boolean

Defines if this layer is a SOV (Share of Voice) layer.

Expand All

object

success

object (Contracts.Common.Jsons.Common.SuccessJson)

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

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

mix

object (Contracts.Connect.Results.Broadcasts.SelectCommunicationMixesResultCommunicationMix)

string | null

ID of the communication mix.

code

string | null

The unique code of the communication mix.

name

string | null

Name of the communication mix.

loopLengthSec

number (double) | null

Total length of one loop (all content types combined) in seconds.

contentTypes

Array of object (Contracts.Connect.Results.Broadcasts.SelectContentTypeJson) | null

List of content types that can be used in this communication mix.

object

string | null

ID of the content type.

code

string | null

Unique code of the content type.

name

string | null

Name of the content type.

durationSecs

number (double) | null

The duration of the content type in seconds.

periods

Array of object (Contracts.Connect.Results.Broadcasts.SelectPeriodJson) | null

List of periods when the communication mix is active. An empty list means always active.

object

string | null

ID of the period.

code

string | null

Unique code of the period.

startDateTime

string (date-time) | null

Start date and time of the period. If null, the period starts immediately.

endDateTime

string (date-time) | null

End date and time of the period. If null, the period does not end.

weekdayStartTime

string (date-span) | null

Start time of the period on weekdays. If null, the period starts at midnight.

weekdayEndTime

string (date-span) | null

End time of the period on weekdays. If null, the period ends at midnight.

dayOfWeeks

string

Valid values[ "None", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "NotWeekends", "Saturday", "Sunday", "Weekends", "All" ]

layers

Array of object (Contracts.Connect.Results.Broadcasts.SelectBroadcastLayerJson) | null

List of broadcast layers to which this communication mix will be applied. An empty list means all layers.

object

string | null

ID of the broadcast layer.

code

string | null

Unique code of the broadcast layer.

name

string | null

Name of the broadcast layer.

isMain

boolean | null

Defines if this layer is the main layer or not.

isSOV

boolean

Defines if this layer is a SOV (Share of Voice) layer.

Expand All

object

success

object (Contracts.Common.Jsons.Common.SuccessJson)

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

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

mix

object (Contracts.Connect.Results.Broadcasts.SelectCommunicationMixesResultCommunicationMix)

string | null

ID of the communication mix.

code

string | null

The unique code of the communication mix.

name

string | null

Name of the communication mix.

loopLengthSec

number (double) | null

Total length of one loop (all content types combined) in seconds.

contentTypes

Array of object (Contracts.Connect.Results.Broadcasts.SelectContentTypeJson) | null

List of content types that can be used in this communication mix.

object

string | null

ID of the content type.

code

string | null

Unique code of the content type.

name

string | null

Name of the content type.

durationSecs

number (double) | null

The duration of the content type in seconds.

periods

Array of object (Contracts.Connect.Results.Broadcasts.SelectPeriodJson) | null

List of periods when the communication mix is active. An empty list means always active.

object

string | null

ID of the period.

code

string | null

Unique code of the period.

startDateTime

string (date-time) | null

Start date and time of the period. If null, the period starts immediately.

endDateTime

string (date-time) | null

End date and time of the period. If null, the period does not end.

weekdayStartTime

string (date-span) | null

Start time of the period on weekdays. If null, the period starts at midnight.

weekdayEndTime

string (date-span) | null

End time of the period on weekdays. If null, the period ends at midnight.

dayOfWeeks

string

Valid values[ "None", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "NotWeekends", "Saturday", "Sunday", "Weekends", "All" ]

layers

Array of object (Contracts.Connect.Results.Broadcasts.SelectBroadcastLayerJson) | null

List of broadcast layers to which this communication mix will be applied. An empty list means all layers.

object

string | null

ID of the broadcast layer.

code

string | null

Unique code of the broadcast layer.

name

string | null

Name of the broadcast layer.

isMain

boolean | null

Defines if this layer is the main layer or not.

isSOV

boolean

Defines if this layer is a SOV (Share of Voice) layer.

401

Unauthorized

403

Forbidden

object

type

string | null

title

string | null

status

integer (int32) | null

detail

string | null

instance

string | null

property*

404

Not Found

object

type

string | null

title

string | null

status

integer (int32) | null

detail

string | null

instance

string | null

property*

500

Internal Server Error

Documentation Index

Gets a single communication mix by its ID.