v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB

Event Candidate Activity

Get Event Candidate Activity

Given an event activity id of a candidate, it returns all attributes of the event activity

get/api/v2/events/event-candidate-activities/{eventActivityId}

Path parameters

eventActivityIdstring required

event activity ID of event candidate activity 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

createdAtinteger nullable

Timestamp when this event activity was created

plannedEventIdstring nullable

Planned event id associated with the event activity

updatedBystring nullable

User id which updated this event activity

subkeyIdstring nullable

Subkey id for the event activity

activityResultstring nullable

Activity result for this event activity

dataJsonobject nullable

Data json for the event candidate activity

profileIdstring nullable

Profile Id for the candidate

activityTypestring nullable

Activity type for this event activity

idstring nullable

Event Candidate Activity Id

updatedAtinteger nullable

Timestamp when this event activity was updated

createdBystring nullable

User id which created this event activity

rsvpResponsestring nullable

RSVP response by the candidate

positionIdinteger nullable

Position Id for the position associated to the event for some specific activity types