Sign in

v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB
User Calendar Event

Get User Calendar Event

Given the id of User Calendar Event, it returns all attributes of the entity

get/api/v2/core/user-calendar-events/{userCalendarEventId}

Path parameters

userCalendarEventIdstring required

Entity Id of User Calendar 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 user calendar event was created

plannedEventIdinteger nullable

Planned Event id associated with the user calendar event

assigneeUserIdstring nullable

User id of the assignee for the calendar event

profileIdstring nullable

Profile id of the candidate associated the user calendar event

eventTypestring nullable

Type of the calendar event (e.g. INTERVIEW)

meetingTimeinteger nullable

Meeting timestamp for the user calendar event

creatorUserIdstring nullable

User id of the user who created the calendar event

interviewSlotsJsonobject nullable

Interview Slots, each enriched with its feedback_url

templateIdinteger nullable

Template id associated with the user calendar event

idinteger nullable

Id associated with the user calendar event

candidateEmailstring nullable

Candidate email for the user calendar event

durationMinutesinteger nullable

Time duration in minutes of the user calendar event

updatedAtinteger nullable

Timestamp when this user calendar event was last updated

statusstring nullable

Status of the user calendar event

timezonestring nullable

Timezone for the user calendar event

positionIdinteger nullable

Position id associated with the user calendar event