Skip to main content
GET
Get broadcast 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.

Response

200 - application/json

Success

name
string
required

Nom de l'application. Sera publié sur les stores.

Required string length: 1 - 30
Example:

"x"

_id
string<objectId>
required
Example:

"64b7f8b6f23a4a4f3d0a9b12"

_createdAt
string<date-time>
required
Example:

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

menu
object | null

Configuration du menu.

structure
object | null

Broadcast navigation structure.

capabilities
object | null

Capacités spécifiques du broadcast, à destination des diffuseurs.

bottomBar
object | null

Configuration theorique de la barre basse.

appBar
object | null

Configuration de l'en-tete global.

home
object | null

Configuration de la page d'accueil.

shortDescription
string | null

Description courte de l'application, sera publié sur les stores.

Maximum string length: 80
Example:

"string"

description
string | null

Description longue de l'application, sera publié sur les stores.

Maximum string length: 4000
Example:

"string"

theme
object | null

Theme global de l'application.

type
string | null

Type de broadcast.

Example:

"string"

status
enum<string> | null

Statut du broadcast.

Available options:
onboarding,
onboardingCapturingWebsite,
onboardingGeneratingAssets,
onboardingApplyingTheme,
onboardingBuildingContent,
onboardingFinalizing,
onboardingFailed,
idle
Example:

"onboarding"

isPrivate
boolean | null

Indique si le broadcast est exclu des accès publics.

Example:

true

isWeb
boolean | null

Indique si le broadcast doit être diffusé sur le web.

Example:

true

isApp
boolean | null

Indique si le broadcast doit être diffusé dans une application.

Example:

true

authProviders
(oAuth · object | fixedKeys · object)[] | null

Providers d'authentification disponibles pour le broadcast.

Configuration d'un provider d'authentification pour le broadcast.

authData
(basic · object | apiKey · object | oauth · object | fixedKeys · object)[] | null

Credentials enregistrés pour les providers d'authentification du broadcast.

Credentials standalone (basic/apiKey) du broadcast.

platforms
object | null

Identifiants des comptes de publication personnalisés.

revisionId
string<objectId> | null
Required string length: 24
Example:

"64b7f8b6f23a4a4f3d0a9b12"

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

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

_reference
string | null
Example:

"string"