Get virtual event settings

GET

/api/events/{eventid}/virtual-info

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api.eventpoint.io/api/events/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/virtual-info"),
    Headers =
    {
        { "x-api-key", "<x-api-key>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://api.eventpoint.io/api/events/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/virtual-info';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.eventpoint.io/api/events/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/virtual-info \
  --header 'x-api-key: <x-api-key>'

Authorizations

ApiKeyAuth
BearerAuth

Parameters

Path Parameters

eventid

required

string format: uuid

The event identifier.

Responses

200

object

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

eventId

string format: uuid

organizationId

null | string format: uuid

name

null | string

description

null | string

url

null | string

externalId

null | string

externalResourceType

null | string

extraInfo

null | string

publish

boolean

openDate

null | string format: date-time

closeDate

null | string format: date-time

displayMinsAfterStart

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

numMinsToDisplay

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

meta

null | object

imageUrl

null | string

imageAssetId

null | string format: uuid

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

streamServer

null | string

streamKey

null | string

securityType

null | string

iframeEnabled

boolean

textChatEnabled

boolean

reactionsEnabled

boolean

videoChatEnabled

boolean

audioChatEnabled

boolean

liveStreamEnabled

boolean

consumerAppId

null | string format: uuid

onDemandEnabled

boolean

onDemandUrl

null | string

livestreamUrl

null | string

externalMeetingUrl

null | string

externalEmbed

null | string

meetingSize

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

kind

One of:

null
integer

null

object

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

eventId

string format: uuid

organizationId

null | string format: uuid

name

null | string

description

null | string

url

null | string

externalId

null | string

externalResourceType

null | string

extraInfo

null | string

publish

boolean

openDate

null | string format: date-time

closeDate

null | string format: date-time

displayMinsAfterStart

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

numMinsToDisplay

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

meta

null | object

imageUrl

null | string

imageAssetId

null | string format: uuid

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

streamServer

null | string

streamKey

null | string

securityType

null | string

iframeEnabled

boolean

textChatEnabled

boolean

reactionsEnabled

boolean

videoChatEnabled

boolean

audioChatEnabled

boolean

liveStreamEnabled

boolean

consumerAppId

null | string format: uuid

onDemandEnabled

boolean

onDemandUrl

null | string

livestreamUrl

null | string

externalMeetingUrl

null | string

externalEmbed

null | string

meetingSize

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

kind

One of:

null
integer

null

Example^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "created": "2026-04-15T12:00:00Z",
  "modified": "2026-04-15T12:00:00Z",
  "etag": "example",
  "projectId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "eventId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "organizationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "description": "example",
  "url": "example",
  "externalId": "example",
  "externalResourceType": "example",
  "extraInfo": "example",
  "publish": true,
  "openDate": "2026-04-15T12:00:00Z",
  "closeDate": "2026-04-15T12:00:00Z",
  "displayMinsAfterStart": 1,
  "numMinsToDisplay": 1,
  "meta": "example",
  "imageUrl": "example",
  "imageAssetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "style": {
    "hasStyle": true,
    "primaryColor": "example",
    "secondaryColor": "example",
    "backgroundColor": "example",
    "textColor": "example",
    "contrastColor": "example",
    "fontFamily": "example",
    "secondaryContrastColor": "example"
  },
  "profileImages": {
    "defaultOriginal": "example",
    "defaultLarge": "example",
    "defaultMedium": "example",
    "defaultSmall": "example",
    "thumbnailSmall": "example",
    "thumbnailLarge": "example"
  },
  "streamServer": "example",
  "streamKey": "example",
  "securityType": "example",
  "iframeEnabled": true,
  "textChatEnabled": true,
  "reactionsEnabled": true,
  "videoChatEnabled": true,
  "audioChatEnabled": true,
  "liveStreamEnabled": true,
  "consumerAppId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "onDemandEnabled": true,
  "onDemandUrl": "example",
  "livestreamUrl": "example",
  "externalMeetingUrl": "example",
  "externalEmbed": "example",
  "meetingSize": 1,
  "kind": "example"
}

object

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

eventId

string format: uuid

organizationId

null | string format: uuid

name

null | string

description

null | string

url

null | string

externalId

null | string

externalResourceType

null | string

extraInfo

null | string

publish

boolean

openDate

null | string format: date-time

closeDate

null | string format: date-time

displayMinsAfterStart

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

numMinsToDisplay

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

meta

null | object

imageUrl

null | string

imageAssetId

null | string format: uuid

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

streamServer

null | string

streamKey

null | string

securityType

null | string

iframeEnabled

boolean

textChatEnabled

boolean

reactionsEnabled

boolean

videoChatEnabled

boolean

audioChatEnabled

boolean

liveStreamEnabled

boolean

consumerAppId

null | string format: uuid

onDemandEnabled

boolean

onDemandUrl

null | string

livestreamUrl

null | string

externalMeetingUrl

null | string

externalEmbed

null | string

meetingSize

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

kind

One of:

null
integer

null

Example^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "created": "2026-04-15T12:00:00Z",
  "modified": "2026-04-15T12:00:00Z",
  "etag": "example",
  "projectId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "eventId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "organizationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "description": "example",
  "url": "example",
  "externalId": "example",
  "externalResourceType": "example",
  "extraInfo": "example",
  "publish": true,
  "openDate": "2026-04-15T12:00:00Z",
  "closeDate": "2026-04-15T12:00:00Z",
  "displayMinsAfterStart": 1,
  "numMinsToDisplay": 1,
  "meta": "example",
  "imageUrl": "example",
  "imageAssetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "style": {
    "hasStyle": true,
    "primaryColor": "example",
    "secondaryColor": "example",
    "backgroundColor": "example",
    "textColor": "example",
    "contrastColor": "example",
    "fontFamily": "example",
    "secondaryContrastColor": "example"
  },
  "profileImages": {
    "defaultOriginal": "example",
    "defaultLarge": "example",
    "defaultMedium": "example",
    "defaultSmall": "example",
    "thumbnailSmall": "example",
    "thumbnailLarge": "example"
  },
  "streamServer": "example",
  "streamKey": "example",
  "securityType": "example",
  "iframeEnabled": true,
  "textChatEnabled": true,
  "reactionsEnabled": true,
  "videoChatEnabled": true,
  "audioChatEnabled": true,
  "liveStreamEnabled": true,
  "consumerAppId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "onDemandEnabled": true,
  "onDemandUrl": "example",
  "livestreamUrl": "example",
  "externalMeetingUrl": "example",
  "externalEmbed": "example",
  "meetingSize": 1,
  "kind": "example"
}

403

Forbidden

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

Get virtual event settings

Authorizations

Parameters

Path Parameters

Responses

200

Examplegenerated

Examplegenerated

403

Examplegenerated

Examplegenerated

404

Examplegenerated

Examplegenerated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated