v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB
Profile Note

Get Profile Note

Given a profile note id of a candidate, it returns all attributes of the profile note

get/api/v2/core/profile-notes/{profileNoteId}

Path parameters

profileNoteIdstring required

profile note ID of note 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

creatorEmailstring nullable

creator email of candidate

idstring nullable

Note id of candidate

noteTypestring nullable

Note type of candidate

notestring nullable

Note of candidate

profileIdstring nullable

Profile id of candidate

positionIdstring nullable

Position id associated with the note

createdTimeinteger nullable

created time of candidate in datetime format