Skip to main content
GET
Get broadcastHost resource

Authorizations

X-API-KEY
string
header
required

Use the format X-API-KEY YOUR_API_KEY. Each key is tied to a single broadcast.

Path Parameters

userId
string<objectId>
required

Resource identifier.

broadcastId
string<objectId>
required

Resource identifier.

broadcastHostId
string<objectId>
required

Resource identifier.

Response

200 - application/json

Success

name
string
required

Nom affiche du host/intervenant.

Required string length: 1 - 100
Example:

"x"

status
enum<string>
default:draft
required

Statut editorial (draft, published).

Available options:
draft,
published
_id
string<objectId>
required
Example:

"64b7f8b6f23a4a4f3d0a9b12"

_createdAt
string<date-time>
required
Example:

"2024-01-01T00:00:00.000Z"

categoryIds
string<objectId>[] | null

Categories associees au host.

Required string length: 24
media
any | null

Portrait ou visuel du host.

role
string | null

Fonction/role du host.

Required string length: 1 - 100
Example:

"x"

defaultLocale
enum<string> | null

Locale par defaut.

Available options:
fr,
en,
es
Example:

"fr"

Liens sociaux du host.

blocks
(media · object | button · object | divider · object | embed · object | question · object | paragraph · object | sessions · object | hosts · object | interestPoints · object | articles · object | countdown · object | section · object | socials · object | meteo · object | map · object)[] | null

Contenu detaille du host.

Bloc de contenu rendu dans l'ordre du tableau. Type peut être title pour un titre, paragraph pour un texte markdown, media pour une image ou une video, embed pour un contenu embarqué (ex: tweet, video externe, etc), button pour un bouton cliquable, question pour une question avec reponses cliquables, sessions, hosts ou interestPoints pour afficher des listes de sessions, hosts ou points d'interet d'un broadcast, articles pour afficher une selection d'articles d'un broadcast, ou countdown pour afficher un compte a rebours vers une date cible.

localeDetails
object | null

Variantes localisees du host.

metadata
object
_updatedAt
string<date-time> | null
Example:

"2024-01-01T00:00:00.000Z"

_reference
string | null
Example:

"string"