v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB
Events

Get Planned Event

Given a planned event id, it returns all attributes of the planned event

get/api/v2/events/planned-events/{plannedEventId}

Path parameters

plannedEventIdstring required

planned event ID of planned event in Eightfold

Query parameters

excludestring

Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

keyListstring

Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

Headers

Authorizationstring required

The secret key to access the api. It starts with the bearer token

Response

OK

createdAtinteger nullable

Timestamp when this event was created

isCancelledboolean nullable
eventSpeakersstring[] nullable

List of speakers

activeRegistrationsstring nullable

active registrations

eventTeamDataJsonobject nullable

Event team data

eventBucketstring nullable

Bucket of the event

addressstring nullable

Address of venue

eventCustomFieldsJsonobject nullable

Event custom fields

eventTypestring nullable
institutionstring nullable

Institution related to event

selectedTimezonestring nullable

Selected time zome

namestring nullable

Name of the event

eventLocationTypestring nullable
idstring nullable

id

parentIdstring nullable

Parent id of the event

venuestring nullable

Venue of the event

endTimestampinteger nullable

Ending timestamp of event

isPublishedboolean nullable
eventLandingPagestring nullable

Event landing page

statusstring nullable
createdBystring nullable

User id which created this event

eventCategorystring nullable

Category of the event

startTimestampinteger nullable

Starting time stamp of event

whenstring nullable

When tag of the event

descriptionstring nullable

Description of event