EIeightfold
Event Candidate Activity

List Event Candidate Activities

Search event candidate activities using specific filter parameters and get all attributes of the entities. JWT callers see only rows whose event they can read and whose candidate is visible to them on that event's Candidates tab; page by totalCount, since a page can be empty while more visible rows follow.

get/api/v2/events/event-candidate-activities

Request

Query parameters

startinteger

Specifies the offset value to start for the page

limitinteger

Specifies the number of entries to be returned for the page

queryLimitstring

Limit on the total number of search results, defaults to 100

plannedEventIdstring

Filter on planned event id for the event acitivities

profileIdstring

Filter on profile id of the candidate

positionIdstring

Filter on position id associated with the event activity

activityTypestring

Filter on type of activity

subkeyIdstring

Filter on subkey id of the event activity

createdBystring

Filter on user id who created the event

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

Changes

No recorded changes to this operation across all 2 revisions of this API.